You are not signed in. Log in or Register
May 11th, 2014

Z33K.com is shutting down on May 25th.

When my brother Max and I set out to make tournaments more accessible in 2010, we never expected the project to be so successful. After thousands of tournaments, 100,000+ players, and 385,546 tournament registrations, it is time for us to move on. There are too many stories to share here, but we will always be grateful for the opportunity to interact with a diverse group of competitive gaming communities, tournament organizers, volunteers, coaches, shout casters, and gamers from all over the world.

While Z33K has always been free, we do not have time or resources to actively drive the project forward. If someone is interested in taking over the project, feel free to contact lane@z33k.com.

gg,
Lane and Max
Z33K.com Founders

Z33K.com REST API Documentation v1


Notes

- API Calls are GET unless otherwise specified
- All DateTimes are epoch format. Fields suffixed with _utc are converted to UTC and in the format: Fri Jul 25 2014, 15:56 UTC
- Fields that are suffixed with _html may contain html. These fields have been sanitized with the following rules: 1) Any HTML element not in this list will be removed: a, b, br, center, dd, div, dl, dt, em, h1, h2, h3, h4, h5, h6, i, img, li, p, pre, span, strike, strong, sub, sup, table, tbody, td, th, thead, tr, u, ul. 2) The HTML style and class attributes are allowed on a, img, p, span, table, tbody, td, th, thead, tr. In addition to these, href, title are allowed for a, and src, width, height, alt are allowed for img. All other attributes are removed.
- For submitting API-related feedback, bugs or requests use the forums or email support@z33k.com

Client Implementations

z33k4J: A simple java client library that provides easy-access to the z33k.com REST API. It can parse tournaments groups (json) and extract all group data, including upcoming/running/past tournaments. Contributed by Bronte of starcade-gaming.org.

Tournaments

Tournaments > tournaments top

Search for tournament. Note: this method will be replaced soon. Here are a few limitations:
- The query string arguments are done in a ghetto rails-style, for instance to see events in just EU and NA regions, one would write: ?region[]=na®ion[]=eu.
- it has a root node not like any of the other APi calls. This will also be fixed in a future version.
- urls are relative
- not much information is provided
- no xml support
  • Query String Arguments
  • - sport - starcraft2 | dota2 | etc - limit results to only tournaments with the provided game permalink
  • - status - in-progress | registering | past - note: registering includes checkin and signup. If past, the order is descending, otherwise it is ascending
  • - host - z33k | player
  • - query - search by name
  • - region - eu | na | other - starcraft2 only
Sample Queries

Upcoming Starcraft 2 Tournaments
GET http://api.z33k.com/v1/tournaments.json?sport=starcraft2&status=registering

In-progress Dota2 Tournaments
GET http://api.z33k.com/v1/tournaments.json?sport=dota2&status=in-progress

Starcraft2 Tournaments with 'daily' the title in EU and NA regions only
GET http://api.z33k.com/v1/tournaments.json?query=daily&sport=starcraft2®ion%5B%5D=na®ion%5B%5D=eu
xml
  Not Supported
json
  
{
  "models": [
    {
      "name": "Simply Silver #3",
      "url": "/games/starcraft2/tournaments/257-simply-silver-3",
      "bracket_url": "/games/starcraft2/tournaments/257-simply-silver-3/brackets",
      "stream_url": "",
      "stream_live":"false",
      "logo": "/images/plain_default_matchset_banner.png",
      "plain_logo": "/images/plain_default_matchset_banner.png",
      "start_at": "8 months ago",
      "countdown": "631:38",
      "prize": "",
      "type": "EU",
      "status": "signup",
      "leagues": [
        "Bronze",
        "Silver"
      ],
      "players": "0",
      "community": null,
      "max_players": "32"
    }
  ]
}
        

Tournaments > tournaments/:id top

Get extended details for the given tournament id. For more information about the tournament settings, see the Tournament Guide
  • Attributes
  • - players_pre_registered: count of teams marked as pre-registered by the tournament admin, 0 if pre-registration is disabled
  • - players_inactive: count of teams kicked from the tournament, did not check-in, or whose registrations are marked as inactive by the admin tournament admin
  • - players_checked_in: count of teams checked-in
  • - players_active_registered - count of active, registered teams
  • - short_url - Short URL to the tournament, and count of views (hits) it has received. The full URL also included, but hits are not be tracked for it.
  • - short_bracket_url - Short URL to the bracket, and count of views (hits) it has received. The full URL also included, but hits are not be tracked for it.
  • - streams - associated streams, see stream section for details
  • - groups - associated groups
  • - admin_users - users who are admins of the tournament
  • - settings
  • -- publised true|false - is this event visible to the public
  • -- z33k_run true|false - false by default on player-created events
  • -- mode standard|teamseries|zmode - standard by default, teamseries a proleague format
  • -- elimination Single Elimination|Double Elimination
  • -- min_teamsize 1..10 - minimum number of allowed players per team
  • -- max_teamsize 1..10 - maximum number of allowed players per team
  • -- ignore_round_deadlines true|false - default true, if disabled round deadlines will not be displayed on the bracket
  • -- auto_advance true|false - true lets brackets progress beyond round 1. False while tournament is started with latecomers and allow_latecomers_duration not exceeded
  • -- allow_latecomers_duration true|false - 0...60 - number of minutes to allow latecomers
  • -- bracket_group_size - the number of groups to visually display on the bracket, automatically calculated
  • -- preregister true|false - true if only pre-registered players will be seeded into the bracket
  • - id
  • - name
  • - type - tournament|league
  • - lan true|false - true if it is a LAN event
  • - location - For LAN events, the location of the event
  • - irc_channel - default z33k - irc channel on irc.quakenet.org
  • - prize
  • - status - signup|checkin|inprogress|completed
  • - checkin_duration - in minutes
  • - leagues - bronze, silver, gold, platinum, diamond, master, grandmaster
  • - regions - North America, Europe, Korea, Southeast Asia, Taiwan, Russia, South America
  • - header - descriptive text
  • - game - default Starcraft 2 - what game the tournament is for
  • - game_name - the full name of the game, for example: Starcraft 2'
  • - game_name_permalink - the prefix name used in the URL, for example: starcraft2
  • - game_name_short - the short name, for example: sc2
  • - game_size - default: 1v1 - the format of battle
  • - size - tournament's size
  • - sponsors_html - sponsorship logos
  • - rules_html - description of the tournament rules
  • - embed_js_html - html to embed via javascript
  • - embed_iframe_html - html to embed via iframe
  • - created_at - when the tournament was created
  • - start_at - when the tournament starts
  • - checkin_start_at - when the tournament checkin started
Sample Query
GET http://api.z33k.com/v1/tournaments/78.json
GET http://api.z33k.com/v1/tournaments/78.xml
xml
  <tournament>
  <players-pre-registered type="integer">0</players-pre-registered>
  <players-inactive type="integer">11</players-inactive>
  <players-checked-in type="integer">10</players-checked-in>
  <players-active-registered type="integer">16</players-active-registered>
  <short-url>
    <url>
      <url>http://www.z33k.com/games/starcraft2/tournaments/78-alloy-4</url>
      <full-url>http://www.z33k.com/z/j4</full-url>
      <hits type="integer">0</hits>
    </url>
  </short-url>
  <short-bracket-url>
    <url>
      <url>http://www.z33k.com/games/starcraft2/tournaments/78-alloy-4/brackets</url>
      <full-url>http://www.z33k.com/z/j5</full-url>
      <hits type="integer">0</hits>
    </url>
  </short-bracket-url>
  <streams>
    <stream>
      <id type="integer">1977</id>
      <name>absolutionsc_</name>
      <live type="boolean">true</live>
      <viewers type="integer">7</viewers>
      <rating-average nil="true"></rating-average>
      <rating-count nil="true"></rating-count>
      <preview-image>http://static-cdn.jtvnw.net/previews/live_user_absolutionsc-320x240.jpg</preview-image>
      <source-type>justintv</source-type>
      <source-uid>absolutionsc</source-uid>
      <source-username nil="true"></source-username>
      <source-url>http://www.justin.tv/absolutionsc</source-url>
    </stream>
  </streams>
  <groups type="array">
    <group>
      <id type="integer">19</id>
      <name>z33k Daily</name>
    </group>
  </groups>
  <admin-users type="array">
    <admin-user>
      <id type="integer">655</id>
      <name>Desolationx</name>
    </admin-user>
    <admin-user>
      <id type="integer">742</id>
      <name>Lackskills</name>
    </admin-user>
  </admin-users>
  <settings>
    <published type="boolean">true</published>
    <z33k-run type="boolean">true</z33k-run>
    <mode>standard</mode>
    <elimination>Single Elimination</elimination>
    <min-teamsize type="integer">1</min-teamsize>
    <max-teamsize type="integer">5</max-teamsize>
    <ignore-round-deadlines type="boolean">true</ignore-round-deadlines>
    <auto-advance type="boolean">true</auto-advance>
    <allow-latecomers type="boolean">false</allow-latecomers>
    <allow-latecomers-duration type="integer">10</allow-latecomers-duration>
    <bracket-group-size type="integer">16</bracket-group-size>
    <preregister type="boolean">false</preregister>
  </settings>
  <id type="integer">78</id>
  <name>Alloy #4</name>
  <type>Tournament</type>
  <lan type="boolean">false</lan>
  <location nil="true"></location>
  <irc-channel>z33k</irc-channel>
  <prize nil="true"></prize>
  <status>completed</status>
  <checkin-duration type="integer">30</checkin-duration>
  <leagues type="array">
    <league>Gold</league>
    <league>Platinum</league>
  </leagues>
  <regions type="array">
    <region>North America</region>
  </regions>
  <header></header>
  <game-name>Starcraft 2</game-name>
  <game-name-permalink>starcraft2</game-name-permalink>
  <game-name-short>sc2</game-name-short>
  <game-size>1v1</game-size>
  <size type="integer">16</size>
  <sponsors-html></sponsors-html>
  <rules-html>&lt;br&gt;&lt;br&gtThis is a ONE DAY EVENT. You must check-in to play at the start time!</rules-html>
  <embed-js-html>&lt;div id="z33k_bracket_embed_78" data-width="960" data-height="500"&gt;&lt;/div&gt;&lt;script type="text/javascript" src="http://www.z33k.com/games/starcraft2/tournaments/78.js"&gt;&lt;/script&gt;</embed-js-html>
  <embed-iframe-html>&lt;iframe src="http://www.z33k.com/games/starcraft2/tournaments/78/embed" width="960px" height="500px" style="border: 0px;"&gt;&lt;/iframe&gt;</embed-iframe-html>
  <created-at type="integer">1292553651</created-at>
  <created-at-utc>Fri Dec 17 2010, 02:40 UTC</created-at-utc>
  <start-at type="integer">1293417000</start-at>
  <start-at-utc>Mon Dec 27 2010, 02:30 UTC</start-at-utc>
  <checkin-start-at type="integer">1293415200</checkin-start-at>
  <checkin-start-at-utc>Mon Dec 27 2010, 02:00 UTC</checkin-start-at-utc>
</tournament>

        
json
  
{
  "tournament": {
    "players_pre_registered": 0,
    "players_inactive": 11,
    "players_checked_in": 10,
    "players_active_registered": 16,
    "short_url": {
      "url": {
        "url": "http://www.z33k.com/games/starcraft2/tournaments/78-alloy-4",
        "full_url": "http://www.z33k.com/z/j4",
        "hits": 0
      }
    },
    "short_bracket_url": {
      "url": {
        "url": "http://www.z33k.com/games/starcraft2/tournaments/78-alloy-4/brackets",
        "full_url": "http://www.z33k.com/z/j5",
        "hits": 0
      }
    },
    "streams": {
      "stream": {
        "id": 1977,
        "name": "absolutionsc_",
        "live": true,
        "viewers": 7,
        "rating_average": null,
        "rating_count": null,
        "preview_image": "http://static-cdn.jtvnw.net/previews/live_user_absolutionsc-320x240.jpg",
        "source_type": "justintv",
        "source_uid": "absolutionsc",
        "source_username": null,
        "source_url": "http://www.justin.tv/absolutionsc"
      }
    },
    "groups": [
      {
        "id": 19,
        "name": "z33k Daily"
      }
    ],
    "admin_users": [
      {
        "id": 655,
        "name": "Desolationx"
      },
      {
        "id": 742,
        "name": "Lackskills"
      }
    ],
    "settings": {
      "published": true,
      "z33k_run": true,
      "mode": "standard",
      "elimination": "Single Elimination",
      "min_teamsize": 1,
      "max_teamsize": 5,
      "ignore_round_deadlines": true,
      "auto_advance": true,
      "allow_latecomers": false,
      "allow_latecomers_duration": 10,
      "bracket_group_size": 16,
      "preregister": false
    },
    "id": 78,
    "name": "Alloy #4",
    "type": "Tournament",
    "lan": false,
    "location": null,
    "irc_channel": "z33k",
    "prize": null,
    "status": "completed",
    "checkin_duration": 30,
    "leagues": [
      "Gold",
      "Platinum"
    ],
    "regions": [
      "North America"
    ],
    "header": "",
    "game_name": "Starcraft 2",
    "game_name_permalink": "starcraft2",
    "game_name_short": "sc2",
    "game_size": "1v1",
    "size": 16,
    "sponsors_html": "",
    "rules_html": "<br><br>This is a ONE DAY EVENT. You must check-in to play at the start time!",
    "embed_js_html": "<div id=\"z33k_bracket_embed_78\" data-width=\"960\" data-height=\"500\"></div><script type=\"text/javascript\" src=\"http://www.z33k.com/games/starcraft2/tournaments/78.js\"></script>",
    "embed_iframe_html": "<iframe src=\"http://www.z33k.com/games/starcraft2/tournaments/78/embed\" width=\"960px\" height=\"500px\" style=\"border: 0px;\"></iframe>",
    "created_at": 1292553651,
    "created_at_utc": "Fri Dec 17 2010, 02:40 UTC",
    "start_at": 1293417000,
    "start_at_utc": "Mon Dec 27 2010, 02:30 UTC",
    "checkin_start_at": 1293415200,
    "checkin_start_at_utc": "Mon Dec 27 2010, 02:00 UTC"
  }
}
        

Tournaments > tournaments/:id/teams top

Get a list of teams registered for the given tournament id. For more information about the settings, see the Tournament Guide
  • Attributes
  • - one_man_team true|false - true if it is a one person team
  • - active true|false - true unless team kicked from the tournament, did not check-in, or whose registrations are marked as inactive by the admin tournament admin
  • - preregistered true|false
  • - latecomer true|false - true if the team joined as a latecomer
  • - seat - the teams seat number, used for placment in the brackets
  • - signup_at - when the team signed up
  • - checked_in_at - when the team checked in, will be blank until the entire team is checked in
  • - players - a list of players from the team that are registered for the given tournament
  • -- checked_in_at - when the player checked in
  • -- game-account
  • --- one_vs_one_league_points - bnet 1v1 ladder points
  • --- one_vs_one_league - bnet 1v1 ladder league
  • --- bnet-region - players region
  • --- sc2ranks-url - the URL to the sc2ranks.com profile for the user
  • --- bnet-profile-url - the URL to the bnet profile
Sample Query
GET http://api.z33k.com/v1/tournaments/73/teams.json
GET http://api.z33k.com/v1/tournaments/73/teams.xml
xml
  <hash>
  <teams type="array">
    <team>
      <id type="integer">1907</id>
      <name>Secret Base 3</name>
      <tag>SB3</tag>
      <win type="integer">0</win>
      <loss type="integer">0</loss>
      <nc type="integer">0</nc>
      <one-man-team type="boolean">false</one-man-team>
      <active type="boolean">false</active>
      <preregistered type="boolean">false</preregistered>
      <latecomer type="boolean">false</latecomer>
      <seat nil="true"></seat>
      <signup-at type="integer">1292186072</signup-at>
      <signup-at-utc>Sun Dec 12 2010, 20:34 UTC</signup-at-utc>
      <checked-in-at type="integer">0</checked-in-at>
      <checked-in-at-utc nil="true"></checked-in-at-utc>
      <players type="array">
        <player>
          <id type="integer">2141</id>
          <race>protoss</race>
          <checked-in-at type="integer">1292373113</checked-in-at>
          <checked-in-at-utc>Wed Dec 15 2010, 00:31 UTC</checked-in-at-utc>
          <bnet-name>fireycow</bnet-name>
          <bnet-code>448</bnet-code>
          <country>Canada</country>
          <name>fireycow</name>
          <game-account>
            <1v1-league-points nil="true"></1v1-league-points>
            <1v1-league>Platinum</1v1-league>
            <bnet-region>North America</bnet-region>
            <sc2ranks-url>http://www.sc2ranks.com/us/597244/fireycow</sc2ranks-url>
            <bnet-profile-url>http://us.battle.net/sc2/en/profile/597244/1/Fireycow/</bnet-profile-url>
          </game-account>
        </player>
        <player>
          <id type="integer">2146</id>
          <race>protoss</race>
          <checked-in-at type="integer">0</checked-in-at>
          <checked-in-at-utc nil="true"></checked-in-at-utc>
          <bnet-name>Chuman</bnet-name>
          <bnet-code>614</bnet-code>
          <country>Canada</country>
          <name>Chuman</name>
          <game-account>
            <1v1-league-points nil="true"></1v1-league-points>
            <1v1-league>Silver</1v1-league>
            <bnet-region>North America</bnet-region>
            <sc2ranks-url>http://www.sc2ranks.com/</sc2ranks-url>
            <bnet-profile-url nil="true"></bnet-profile-url>
          </game-account>
        </player>
      </players>
    </team>
json
  
{
  "teams": [
    {
      "id": 1907,
      "name": "Secret Base 3",
      "tag": "SB3",
      "win": 0,
      "loss": 0,
      "nc": 0,
      "one_man_team": false
      "active": false,
      "preregistered": false,
      "latecomer": false,
      "seat": null,
      "signup_at": 1292186072,
      "signup_at_utc": "Sun Dec 12 2010, 20:34 UTC",
      "checked_in_at": 0,
      "checked_in_at_utc": null,
      "players": [
        {
          "id": 2141,
          "race": "protoss",
          "checked_in_at": 1292373113,
          "checked_in_at_utc": "Wed Dec 15 2010, 00:31 UTC",
          "bnet_name": "fireycow",
          "bnet_code": "448",
          "country": "Canada",
          "name": "fireycow",
          "game_account": {
            "one_vs_one_league_points": null,
            "one_vs_one_league": "Platinum",
            "bnet_region": "North America",
            "sc2ranks_url": "http://www.sc2ranks.com/us/597244/fireycow",
            "bnet_profile_url": "http://us.battle.net/sc2/en/profile/597244/1/Fireycow/"
          }
        },
        {
          "id": 2146,
          "race": "protoss",
          "checked_in_at": 0,
          "checked_in_at_utc": null,
          "bnet_name": "Chuman",
          "bnet_code": "614",
          "country": "Canada",
          "name": "Chuman",
          "game_account": {
            "one_vs_one_league_points": null,
            "one_vs_one_league": "Silver",
            "bnet_region": "North America",
            "sc2ranks_url": "http://www.sc2ranks.com/",
            "bnet_profile_url": null
          }
        }
      ]
    }
  ]
}
        

Tournaments > tournaments/:id/brackets top

Get the bracket tree structure for the given tournament.

This is the same underlying structure used for rendering brackets on z33k.com - it can be used to provide a fully integrated or custom bracket for your application. In our experience rendering a bracket can be difficult, so if you simply want to embed a bracket, use the embed-iframe-html or embed-js-html on tournaments/:id instead.

The brackets are broken into a series of bracket trees, which contain multiple rounds. Bracket tree attributes:
- bracket-type wb|lb - winners bracket or losers bracket for double elimination tournaments
- last true|false - true if the current tree holds the ending rounds of the losers bracket or winners bracket. Used to display the bracket in multiple split sections.
- start true|false - true if the current tree holds the starting rounds of the losers bracket or winners bracket. Used to display the bracket in multiple split sections.
- stacked_finals true|false - true for double elimination tournaments rounds that are size 16, 64, or 128, in this case the grand finals match #2 needs to be stacked on top of the grand finals match #1 in order to remain within 6 round width limit.
- early_end true|false - true in double elimination tournaments if there was no grand final #2 match, false if the tournament has not ended yet, or both finals matches needed to be played to produce a winner
- title - the bracket tree title, eg: Winners Bracket Finalists

Bracket trees are broken into a series of rounds, which are read from left to right. Round attributes:
- title
- best_of - minimum number of games required to win each match
- map - what map(s) the games are to be played on

Rounds contain multiple rows, which are read top to bottom. Row contains a match_id, and the teams participating in the match. Also included:
- match_id
- reported_by_user_id - who reported the match, may be nil for older tournaments
- reported-at - when the match was reported, may be nil for older tournaments

Rows usually come in pairs, eg: team a vs team b with the same match_id, however in some cases there are singleton rows, such as the cell that contains the winner of the tournament. Row also contains team, with these attributes:
- team_id
- name - the name of the team, BYE, TBD, or empty string
- status winner|loser|undecided - the result of the match, this will be blank if the match is marked as hidden
- players - the bnet name and code, race and user-ids of players on the team

Sample Queries

32-player double elimination with finals match #2
GET http://api.z33k.com/v1/tournaments/573/brackets.json
GET http://api.z33k.com/v1/tournaments/573/brackets.xml

32-player double elimination without finals match
GET http://api.z33k.com/v1/tournaments/574/brackets.json
GET http://api.z33k.com/v1/tournaments/574/brackets.xml

128-player single elimination
GET http://api.z33k.com/v1/tournaments/901/brackets.json
GET http://api.z33k.com/v1/tournaments/901/brackets.xml

8-player single elimination
GET http://api.z33k.com/v1/tournaments/377/brackets.json
GET http://api.z33k.com/v1/tournaments/377/brackets.xml

xml
      
<hash>
  <bracket-trees type="array">
    <bracket-tree>
      <bracket-type>wb</bracket-type>
      <last type="boolean">true</last>
      <start type="boolean">true</start>
      <stacked-finals nil="true"></stacked-finals>
      <early-end nil="true"></early-end>
      <title nil="true"></title>
      <tree>
        <rounds type="array">
          <round>
            <title>Round 1</title>
            <best-of type="integer">1</best-of>
            <map>Slag Pits</map>
            <rows type="array">
              <row>
                <match-id type="integer">19785</match-id>
                <reported-by-user-id nil="true"></reported-by-user-id>
                <reported-at nil="true"></reported-at>
                <reported-at-utc nil="true"></reported-at-utc>
                <team>
                  <team-id type="integer">6740</team-id>
                  <name>krhju</name>
                  <status>winner</status>
                  <players type="array">
                    <player>
                      <name>kRhju.748</name>
                      <race>zerg</race>
                      <user-id type="integer">7040</user-id>
                    </player>
                  </players>
                </team>
              </row>
              <row>
                <match-id type="integer">19785</match-id>
                <reported-by-user-id nil="true"></reported-by-user-id>
                <reported-at nil="true"></reported-at>
                <reported-at-utc nil="true"></reported-at-utc>
                <team>
                  <team-id type="integer">6700</team-id>
                  <name>drolla</name>
                  <status>loser</status>
                  <players type="array">
                    <player>
                      <name>Drolla.595</name>
                      <race>protoss</race>
                      <user-id type="integer">7005</user-id>
                    </player>
                  </players>
                </team>
              </row>
              <row>
                <match-id type="integer">19784</match-id>
                <reported-by-user-id nil="true"></reported-by-user-id>
                <reported-at nil="true"></reported-at>
                <reported-at-utc nil="true"></reported-at-utc>
                <team>
                  <team-id type="integer">6623</team-id>
                  <name>Dobry&#322;otr</name>
                  <status>winner</status>
                  <players type="array">
                    <player>
                      <name>Baneling.398</name>
                      <race>protoss</race>
                      <user-id type="integer">6933</user-id>
                    </player>
                  </players>
                </team>
              </row>
              <row>
                <match-id type="integer">19784</match-id>
                <reported-by-user-id nil="true"></reported-by-user-id>
                <reported-at nil="true"></reported-at>
                <reported-at-utc nil="true"></reported-at-utc>
                <team>
                  <team-id type="integer">6289</team-id>
                  <name>Cptkaboom</name>
                  <status>loser</status>
                  <players type="array">
                    <player>
                      <name>CptKaboom.591</name>
                      <race>terran</race>
                      <user-id type="integer">6621</user-id>
                    </player>
                  </players>
                </team>
              </row>
              <row>
                <match-id type="integer">19783</match-id>
                <reported-by-user-id nil="true"></reported-by-user-id>
                <reported-at nil="true"></reported-at>
                <reported-at-utc nil="true"></reported-at-utc>
                <team>
                  <team-id type="integer">6723</team-id>
                  <name>sumadin</name>
                  <status>loser</status>
                  <players type="array">
                    <player>
                      <name>Sumadin.785</name>
                      <race>terran</race>
                      <user-id type="integer">7024</user-id>
                    </player>
                  </players>
                </team>
              </row>
              <row>
                <match-id type="integer">19783</match-id>
                <reported-by-user-id nil="true"></reported-by-user-id>
                <reported-at nil="true"></reported-at>
                <reported-at-utc nil="true"></reported-at-utc>
                <team>
                  <team-id type="integer">5948</team-id>
                  <name>osvalds</name>
                  <status>winner</status>
                  <players type="array">
                    <player>
                      <name>Tchaos.527</name>
                      <race>terran</race>
                      <user-id type="integer">6304</user-id>
                    </player>
                  </players>
                </team>
              </row>
              <row>
                <match-id type="integer">19782</match-id>
                <reported-by-user-id nil="true"></reported-by-user-id>
                <reported-at nil="true"></reported-at>
                <reported-at-utc nil="true"></reported-at-utc>
                <team>
                  <team-id type="integer">6616</team-id>
                  <name>kiwitobapas</name>
                  <status>winner</status>
                  <players type="array">
                    <player>
                      <name>KiwiTobapas.622</name>
                      <race>terran</race>
                      <user-id type="integer">6926</user-id>
                    </player>
                  </players>
                </team>
              </row>
              <row>
                <match-id type="integer">19782</match-id>
                <reported-by-user-id nil="true"></reported-by-user-id>
                <reported-at nil="true"></reported-at>
                <reported-at-utc nil="true"></reported-at-utc>
                <team>
                  <team-id type="integer">6293</team-id>
                  <name>Asturas</name>
                  <status>loser</status>
                  <players type="array">
                    <player>
                      <name>Asturas.118</name>
                      <race>terran</race>
                      <user-id type="integer">6625</user-id>
                    </player>
                  </players>
                </team>
              </row>
            </rows>
          </round>
          <round>
            <title>Semi-Finals</title>
            <best-of type="integer">3</best-of>
            <map>Map Vote</map>
            <rows type="array">
              <row>
                <match-id type="integer">19781</match-id>
                <reported-by-user-id nil="true"></reported-by-user-id>
                <reported-at nil="true"></reported-at>
                <reported-at-utc nil="true"></reported-at-utc>
                <team>
                  <team-id type="integer">6740</team-id>
                  <name>krhju</name>
                  <status>loser</status>
                  <players type="array">
                    <player>
                      <name>kRhju.748</name>
                      <race>zerg</race>
                      <user-id type="integer">7040</user-id>
                    </player>
                  </players>
                </team>
              </row>
              <row>
                <match-id type="integer">19781</match-id>
                <reported-by-user-id nil="true"></reported-by-user-id>
                <reported-at nil="true"></reported-at>
                <reported-at-utc nil="true"></reported-at-utc>
                <team>
                  <team-id type="integer">6623</team-id>
                  <name>Dobry&#322;otr</name>
                  <status>winner</status>
                  <players type="array">
                    <player>
                      <name>Baneling.398</name>
                      <race>protoss</race>
                      <user-id type="integer">6933</user-id>
                    </player>
                  </players>
                </team>
              </row>
              <row>
                <match-id type="integer">19780</match-id>
                <reported-by-user-id nil="true"></reported-by-user-id>
                <reported-at nil="true"></reported-at>
                <reported-at-utc nil="true"></reported-at-utc>
                <team>
                  <team-id type="integer">5948</team-id>
                  <name>osvalds</name>
                  <status>loser</status>
                  <players type="array">
                    <player>
                      <name>Tchaos.527</name>
                      <race>terran</race>
                      <user-id type="integer">6304</user-id>
                    </player>
                  </players>
                </team>
              </row>
              <row>
                <match-id type="integer">19780</match-id>
                <reported-by-user-id nil="true"></reported-by-user-id>
                <reported-at nil="true"></reported-at>
                <reported-at-utc nil="true"></reported-at-utc>
                <team>
                  <team-id type="integer">6616</team-id>
                  <name>kiwitobapas</name>
                  <status>winner</status>
                  <players type="array">
                    <player>
                      <name>KiwiTobapas.622</name>
                      <race>terran</race>
                      <user-id type="integer">6926</user-id>
                    </player>
                  </players>
                </team>
              </row>
            </rows>
          </round>
          <round>
            <title>Finals</title>
            <best-of type="integer">3</best-of>
            <map>Map Vote</map>
            <rows type="array">
              <row>
                <match-id type="integer">19779</match-id>
                <reported-by-user-id type="integer">1</reported-by-user-id>
                <reported-at type="datetime">2011-10-10T18:39:59-07:00</reported-at>
                <reported-at-utc>Tue Oct 11 2011, 01:39 UTC</reported-at-utc>
                <team>
                  <team-id type="integer">6623</team-id>
                  <name>Dobry&#322;otr</name>
                  <status>loser</status>
                  <players type="array">
                    <player>
                      <name>Baneling.398</name>
                      <race>protoss</race>
                      <user-id type="integer">6933</user-id>
                    </player>
                  </players>
                </team>
              </row>
              <row>
                <match-id type="integer">19779</match-id>
                <reported-by-user-id type="integer">1</reported-by-user-id>
                <reported-at type="datetime">2011-10-10T18:39:59-07:00</reported-at>
                <reported-at-utc>Tue Oct 11 2011, 01:39 UTC</reported-at-utc>
                <team>
                  <team-id type="integer">6616</team-id>
                  <name>kiwitobapas</name>
                  <status>winner</status>
                  <players type="array">
                    <player>
                      <name>KiwiTobapas.622</name>
                      <race>terran</race>
                      <user-id type="integer">6926</user-id>
                    </player>
                  </players>
                </team>
              </row>
            </rows>
          </round>
          <round>
            <title nil="true"></title>
            <best-of nil="true"></best-of>
            <map nil="true"></map>
            <rows type="array">
              <row>
                <match-id type="integer">19779</match-id>
                <reported-by-user-id type="integer">1</reported-by-user-id>
                <reported-at type="datetime">2011-10-10T18:39:59-07:00</reported-at>
                <reported-at-utc>Tue Oct 11 2011, 01:39 UTC</reported-at-utc>
                <team>
                  <team-id type="integer">6616</team-id>
                  <name>kiwitobapas</name>
                  <status>winner</status>
                  <players nil="true"></players>
                </team>
              </row>
            </rows>
          </round>
        </rounds>
      </tree>
    </bracket-tree>
  </bracket-trees>
</hash>    
json
      
{
  "bracket_trees": [
    {
      "bracket_type": "wb",
      "last": true,
      "start": true,
      "stacked_finals": null,
      "early_end": null,
      "title": null,
      "tree": {
        "rounds": [
          {
            "title": "Round 1",
            "best_of": 1,
            "map": "Slag Pits",
            "rows": [
              {
                "match_id": 19785,
                "reported_by_user_id": null,
                "reported_at": null,
                "reported_at_utc": null,
                "team": {
                  "team_id": 6740,
                  "name": "krhju",
                  "status": "winner",
                  "players": [
                    {
                      "name": "kRhju.748",
                      "race": "zerg",
                      "user_id": 7040
                    }
                  ]
                }
              },
              {
                "match_id": 19785,
                "reported_by_user_id": null,
                "reported_at": null,
                "reported_at_utc": null,
                "team": {
                  "team_id": 6700,
                  "name": "drolla",
                  "status": "loser",
                  "players": [
                    {
                      "name": "Drolla.595",
                      "race": "protoss",
                      "user_id": 7005
                    }
                  ]
                }
              },
              {
                "match_id": 19784,
                "reported_by_user_id": null,
                "reported_at": null,
                "reported_at_utc": null,
                "team": {
                  "team_id": 6623,
                  "name": "Dobry\u0142otr",
                  "status": "winner",
                  "players": [
                    {
                      "name": "Baneling.398",
                      "race": "protoss",
                      "user_id": 6933
                    }
                  ]
                }
              },
              {
                "match_id": 19784,
                "reported_by_user_id": null,
                "reported_at": null,
                "reported_at_utc": null,
                "team": {
                  "team_id": 6289,
                  "name": "Cptkaboom",
                  "status": "loser",
                  "players": [
                    {
                      "name": "CptKaboom.591",
                      "race": "terran",
                      "user_id": 6621
                    }
                  ]
                }
              },
              {
                "match_id": 19783,
                "reported_by_user_id": null,
                "reported_at": null,
                "reported_at_utc": null,
                "team": {
                  "team_id": 6723,
                  "name": "sumadin",
                  "status": "loser",
                  "players": [
                    {
                      "name": "Sumadin.785",
                      "race": "terran",
                      "user_id": 7024
                    }
                  ]
                }
              },
              {
                "match_id": 19783,
                "reported_by_user_id": null,
                "reported_at": null,
                "reported_at_utc": null,
                "team": {
                  "team_id": 5948,
                  "name": "osvalds",
                  "status": "winner",
                  "players": [
                    {
                      "name": "Tchaos.527",
                      "race": "terran",
                      "user_id": 6304
                    }
                  ]
                }
              },
              {
                "match_id": 19782,
                "reported_by_user_id": null,
                "reported_at": null,
                "reported_at_utc": null,
                "team": {
                  "team_id": 6616,
                  "name": "kiwitobapas",
                  "status": "winner",
                  "players": [
                    {
                      "name": "KiwiTobapas.622",
                      "race": "terran",
                      "user_id": 6926
                    }
                  ]
                }
              },
              {
                "match_id": 19782,
                "reported_by_user_id": null,
                "reported_at": null,
                "reported_at_utc": null,
                "team": {
                  "team_id": 6293,
                  "name": "Asturas",
                  "status": "loser",
                  "players": [
                    {
                      "name": "Asturas.118",
                      "race": "terran",
                      "user_id": 6625
                    }
                  ]
                }
              }
            ]
          },
          {
            "title": "Semi-Finals",
            "best_of": 3,
            "map": "Map Vote",
            "rows": [
              {
                "match_id": 19781,
                "reported_by_user_id": null,
                "reported_at": null,
                "reported_at_utc": null,
                "team": {
                  "team_id": 6740,
                  "name": "krhju",
                  "status": "loser",
                  "players": [
                    {
                      "name": "kRhju.748",
                      "race": "zerg",
                      "user_id": 7040
                    }
                  ]
                }
              },
              {
                "match_id": 19781,
                "reported_by_user_id": null,
                "reported_at": null,
                "reported_at_utc": null,
                "team": {
                  "team_id": 6623,
                  "name": "Dobry\u0142otr",
                  "status": "winner",
                  "players": [
                    {
                      "name": "Baneling.398",
                      "race": "protoss",
                      "user_id": 6933
                    }
                  ]
                }
              },
              {
                "match_id": 19780,
                "reported_by_user_id": null,
                "reported_at": null,
                "reported_at_utc": null,
                "team": {
                  "team_id": 5948,
                  "name": "osvalds",
                  "status": "loser",
                  "players": [
                    {
                      "name": "Tchaos.527",
                      "race": "terran",
                      "user_id": 6304
                    }
                  ]
                }
              },
              {
                "match_id": 19780,
                "reported_by_user_id": null,
                "reported_at": null,
                "reported_at_utc": null,
                "team": {
                  "team_id": 6616,
                  "name": "kiwitobapas",
                  "status": "winner",
                  "players": [
                    {
                      "name": "KiwiTobapas.622",
                      "race": "terran",
                      "user_id": 6926
                    }
                  ]
                }
              }
            ]
          },
          {
            "title": "Finals",
            "best_of": 3,
            "map": "Map Vote",
            "rows": [
              {
                "match_id": 19779,
                "reported_by_user_id": 1,
                "reported_at": "2011-10-10T18:39:59-07:00",
                "reported_at_utc": "Tue Oct 11 2011, 01:39 UTC",
                "team": {
                  "team_id": 6623,
                  "name": "Dobry\u0142otr",
                  "status": "loser",
                  "players": [
                    {
                      "name": "Baneling.398",
                      "race": "protoss",
                      "user_id": 6933
                    }
                  ]
                }
              },
              {
                "match_id": 19779,
                "reported_by_user_id": 1,
                "reported_at": "2011-10-10T18:39:59-07:00",
                "reported_at_utc": "Tue Oct 11 2011, 01:39 UTC",
                "team": {
                  "team_id": 6616,
                  "name": "kiwitobapas",
                  "status": "winner",
                  "players": [
                    {
                      "name": "KiwiTobapas.622",
                      "race": "terran",
                      "user_id": 6926
                    }
                  ]
                }
              }
            ]
          },
          {
            "title": null,
            "best_of": null,
            "map": null,
            "rows": [
              {
                "match_id": 19779,
                "reported_by_user_id": 1,
                "reported_at": "2011-10-10T18:39:59-07:00",
                "reported_at_utc": "Tue Oct 11 2011, 01:39 UTC",
                "team": {
                  "team_id": 6616,
                  "name": "kiwitobapas",
                  "status": "winner",
                  "players": null
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
            
    

Groups

Groups > groups/:id top

Get extended details for the given group id. Includes streams and past/upcoming/live tournaments.
  • Attributes
  • - streams - attached streams
  • - member_count - members in the group
  • - admin_users - who owns the group
  • - regions - group regions
  • - event_registration_count - the total number of signups for all events in the group
Sample Query
GET http://api.z33k.com/v1/groups/28.json
GET http://api.z33k.com/v1/groups/28.xml
xml

<group>
  <streams nil="true"></streams>
  <member-count type="integer">3</member-count>
  <past-tournaments type="array">
    <past-tournament>
      <id type="integer">217</id>
      <name>Justin.tv Invitational #2</name>
      <prize>$1000+</prize>
      <status>completed</status>
      <regions type="array">
        <region>North America</region>
      </regions>
      <leagues type="array">
        <league>Diamond</league>
        <league>Master</league>
      </leagues>
      <location></location>
      <game-name>Starcraft 2</game-name>
      <game-name-permalink>starcraft2</game-name-permalink>
      <game-name-short>sc2</game-name-short>
      <game-size>1v1</game-size>
      <players-active-registered type="integer">60</players-active-registered>
      <size type="integer">64</size>
      <embed-js-html>&lt;div id="z33k_bracket_embed_217" data-width="960" data-height="500"&gt;&lt;/div&gt;&lt;script type="text/javascript" src="http://www.z33k.com/games/starcraft2/tournaments/217.js"&gt;&lt;/script&gt;</embed-js-html>
      <embed-iframe-html>&lt;iframe src="http://www.z33k.com/games/starcraft2/tournaments/217/embed" width="960px" height="500px" style="border: 0px;"&gt;&lt;/iframe&gt;</embed-iframe-html>
      <start-at type="integer">1300490100</start-at>
      <start-at-utc>Fri Mar 18 2011, 23:15 UTC</start-at-utc>
      <z33k-run type="boolean">true</z33k-run>
    </past-tournament>
  <upcoming-tournaments type="array"/>
  <live-tournaments type="array"/>
  <admin-users>
    <id type="integer">5</id>
  </admin-users>
  <id type="integer">28</id>
  <name>JustinTV</name>
  <email></email>
  <twitter>Justintv</twitter>
  <facebook></facebook>
  <website>www.justin.tv</website>
  <youtube></youtube>
  <regions type="array">
    <region>North America</region>
  </regions>
  <description-html>Justin.tv is the easiest way to create live video and show anyone in the world...</description-html>
  <created-at type="integer">1302472914</created-at>
  <created-at-utc>Sun Apr 10 2011, 22:01 UTC</created-at-utc>
  <event-registration-count type="integer">1230</registration-count>
</group>

json

{
  "group": {
    "streams": null,
    "member_count": 3,
    "past_tournaments": [
      {
        "id": 217,
        "name": "Justin.tv Invitational #2",
        "prize": "$1000+",
        "status": "completed",
        "regions": [
          "North America"
        ],
        "leagues": [
          "Diamond",
          "Master"
        ],
        "location": "",
        "game_name": "Starcraft 2",
        "game_name_permalink": "starcraft2",
        "game_name_short": "sc2",
        "game_size": "1v1",
        "players_active_registered": 60,
        "size": 64,
        "embed_js_html": "<div id=\"z33k_bracket_embed_217\" data-width=\"960\" data-height=\"500\"></div><script type=\"text/javascript\" src=\"http://www.z33k.com/games/starcraft2/tournaments/217.js\"></script>",
        "embed_iframe_html": "<iframe src=\"http://www.z33k.com/games/starcraft2/tournaments/217/embed\" width=\"960px\" height=\"500px\" style=\"border: 0px;\"></iframe>",
        "start_at": 1300490100,
        "start_at_utc": "Fri Mar 18 2011, 23:15 UTC",
        "z33k_run": true
      },
    ],
    "upcoming_tournaments": [
    ],
    "live_tournaments": [
    ],
    "admin_users": {
      "id": 5
    },
    "id": 28,
    "name": "JustinTV",
    "email": "",
    "twitter": "Justintv",
    "facebook": "",
    "website": "www.justin.tv",
    "youtube": "",
    "regions": [
      "North America"
    ],
    "description_html": "Justin.tv is the easiest way to create live video and show anyone in the world...",
    "created_at": 1302472914,
    "created_at_utc": "Sun Apr 10 2011, 22:01 UTC",
    "event_registration_count": 1230,
  }
}
      

Groups > groups/:id/standings top

Get current user standings for a given group id.
  • Attributes
  • - rank - users rank
  • - finished_top_one - number of finishes in the top one
  • - finished_top_two - number of finishes in the top two
  • - finished_top_three_or_four - number of finishes in the top three or four
  • - user_name - name of the user
  • - user_id - id of the user
  • - ranking_points - ranked points for the user
Sample Query
GET http://api.z33k.com/v1/groups/28/standings.json
GET http://api.z33k.com/v1/groups/28/standings.xml
xml

<standings>
  <group-id type="integer">28</group-id>
  <users type="array">
    <user>
      <rank type="integer">1</rank>
      <updated-at-utc>Fri Sep 16 2011, 02:27 UTC</updated-at-utc>
      <updated-at type="integer">1316140079</updated-at>
      <previous-rank nil="true"></previous-rank>
      <previous-rank-updated-at-utc>Fri Sep 16 2011, 02:27 UTC</previous-rank-updated-at-utc>
      <previous-rank-updated-at type="integer">1316140079</previous-rank-updated-at>
      <user-name>blur</user-name>
      <user-id type="integer">545</user-id>
      <finished-top-one type="integer">1</finished-top-one>
      <finished-top-two type="integer">0</finished-top-two>
      <finished-top-three-or-four type="integer">0</finished-top-three-or-four>
      <ranking-points>155</ranking-points>
    </user>
</standings>
json

{
  "standings": {
    "group_id": 28,
    "users": [
      {
        "rank": 1,
        "updated_at_utc": "Fri Sep 16 2011, 02:27 UTC",
        "updated_at": 1316140079,
        "previous_rank": null,
        "previous_rank_updated_at_utc": "Fri Sep 16 2011, 02:27 UTC",
        "previous_rank_updated_at": 1316140079,
        "user_name": "blur",
        "user_id": 545,
        "finished_top_one": 1,
        "finished_top_two": 0,
        "finished_top_three_or_four": 0,
        "ranking_points": "155"
      }
   ]
}
      

Users

Users > users/:id top

Get extended details for the given user id.
  • Attributes
  • - id - users id
  • - name - public display name
  • - country - users country
  • - record - users win/loss/tie/bye record
  • - player_logo_url - user's avatar image
  • - game_accounts - a list of the user's game accounts
  • - matches - a maximum of 5 of the users matches
  • - tournaments - a maximum of 5 of the users tournaments
Sample Query
GET http://api.z33k.com/v1/users/545.json
GET http://api.z33k.com/v1/users/545.xml
xml

<user>
  <id type="integer">545</id>
  <name>blur</name>
  <country>Canada</country>
  <win type="integer">14</win>
  <loss type="integer">4</loss>
  <bye type="integer">5</bye>
  <player-logo-url>/logos/small/missing.png</player-logo-url>
  <game-accounts type="array">
    <game-account>
      <game>Starcraft 2</game>
      <bnet-name>bLuR</bnet-name>
      <bnet-name-code>519</bnet-name-code>
      <race>terran</race>
      <bnet-league-1v1>Master</bnet-league-1v1>
      <bnet-points type="integer">0</bnet-points>
      <bnet-region>North America</bnet-region>
    </game-account>
  </game-accounts>
  <teams type="array">
    <team>
      <name></name>
      <id type="integer">456</id>
      <role>Leader</role>
      <created-at>Thu Sep 23 2010, 00:46 UTC</created-at>
      <record>14-4-5</record>
    </team>
  </teams>
  <matches type="array">
    <match>
      <match-id type="integer">19398</match-id>
      <event-name>NESC2League Invitational</event-name>
      <event-id type="integer">228</event-id>
      <match-opponent>fayde</match-opponent>
      <outcome>lost</outcome>
      <score>0-2 (Forfeit)</score>
      <reported-at-utc nil="true"></reported-at-utc>
      <reported-at type="integer">0</reported-at>
    </match>
    <match>
      <match-id type="integer">9803</match-id>
      <event-name>Koza Cup</event-name>
      <event-id type="integer">133</event-id>
      <match-opponent>dkiller</match-opponent>
      <outcome>lost</outcome>
      <score>0-3</score>
      <reported-at-utc nil="true"></reported-at-utc>
      <reported-at type="integer">0</reported-at>
    </match>
  </matches>
  <tournaments type="array">
    <tournament>
      <tournament-id type="integer">99</tournament-id>
      <tournament-name>Justin.tv Qualifier #5</tournament-name>
      <finished>1st</finished>
      <win>6</win>
      <loss>0</loss>
      <bye>2</bye>
      <game-size>1v1</game-size>
      <created-at-utc>Wed Dec 29 2010, 23:18 UTC</created-at-utc>
      <created-at type="integer">1293664682</created-at>
    </tournament>
    <tournament>
      <tournament-id type="integer">133</tournament-id>
      <tournament-name>Koza Cup</tournament-name>
      <finished>2nd</finished>
      <win>4</win>
      <loss>1</loss>
      <bye>2</bye>
      <game-size>1v1</game-size>
      <created-at-utc>Sat Jan 08 2011, 22:55 UTC</created-at-utc>
      <created-at type="integer">1294527341</created-at>
    </tournament>
  </tournaments>
</user>


json

{
  "user": {
    "id": 545,
    "name": "blur",
    "country": "Canada",
    "win": 14,
    "loss": 4,
    "bye": 5,
    "player_logo_url": "/logos/small/missing.png",
    "game_accounts": [
      {
        "game": "Starcraft 2",
        "bnet_name": "bLuR",
        "bnet_name_code": "519",
        "race": "terran",
        "bnet_league_1v1": "Master",
        "bnet_points": 0,
        "bnet_region": "North America"
      }
    ],
    "teams": [
      {
        "name": "",
        "id": 456,
        "role": "Leader",
        "created_at": "Thu Sep 23 2010, 00:46 UTC",
        "record": "14-4-5"
      }
    ],
    "matches": [
      {
        "match_id": 19398,
        "event_name": "NESC2League Invitational",
        "event_id": 228,
        "match_opponent": "fayde",
        "outcome": "lost",
        "score": "0-2 (Forfeit)",
        "reported_at_utc": null,
        "reported_at": 0
      },
      {
        "match_id": 9803,
        "event_name": "Koza Cup",
        "event_id": 133,
        "match_opponent": "dkiller",
        "outcome": "lost",
        "score": "0-3",
        "reported_at_utc": null,
        "reported_at": 0
      }
    ],
    "tournaments": [
      {
        "tournament_id": 99,
        "tournament_name": "Justin.tv Qualifier #5",
        "finished": "1st",
        "win": "6",
        "loss": "0",
        "bye": "2",
        "game_size": "1v1",
        "created_at_utc": "Wed Dec 29 2010, 23:18 UTC",
        "created_at": 1293664682
      },
      {
        "tournament_id": 133,
        "tournament_name": "Koza Cup",
        "finished": "2nd",
        "win": "4",
        "loss": "1",
        "bye": "2",
        "game_size": "1v1",
        "created_at_utc": "Sat Jan 08 2011, 22:55 UTC",
        "created_at": 1294527341
      }
    ]
  }
}
      

Users > users/:id/tournaments top

Get details for all tournaments a user participated in.
  • Attributes
  • - tournament_id - id of the tournament
  • - tournament_name - name of the tournament
  • - finished - finishing position of the user
  • - win - tournament record
  • - loss - tournament record
  • - bye - tournament record
  • - game_size - size of the tournament, 1v1, 2v2, etc.
  • - created_at - creation date of the tournament
Sample Query
GET http://api.z33k.com/v1/users/545/tournaments.json
GET http://api.z33k.com/v1/users/545/tournaments.xml
xml

<hash>
  <tournaments type="array">
    <tournament>
      <tournament-id type="integer">99</tournament-id>
      <tournament-name>Justin.tv Qualifier #5</tournament-name>
      <finished>1st</finished>
      <win>6</win>
      <loss>0</loss>
      <bye>2</bye>
      <game-size>1v1</game-size>
      <created-at-utc>Wed Dec 29 2010, 23:18 UTC</created-at-utc>
      <created-at type="integer">1293664682</created-at>
    </tournament>
    <tournament>
      <tournament-id type="integer">133</tournament-id>
      <tournament-name>Koza Cup</tournament-name>
      <finished>2nd</finished>
      <win>4</win>
      <loss>1</loss>
      <bye>2</bye>
      <game-size>1v1</game-size>
      <created-at-utc>Sat Jan 08 2011, 22:55 UTC</created-at-utc>
      <created-at type="integer">1294527341</created-at>
    </tournament>
  </tournaments>
</hash>
json

{
  "tournaments": [
    {
      "tournament_id": 99,
      "tournament_name": "Justin.tv Qualifier #5",
      "finished": "1st",
      "win": "6",
      "loss": "0",
      "bye": "2",
      "game_size": "1v1",
      "created_at_utc": "Wed Dec 29 2010, 23:18 UTC",
      "created_at": 1293664682
    },
    {
      "tournament_id": 133,
      "tournament_name": "Koza Cup",
      "finished": "2nd",
      "win": "4",
      "loss": "1",
      "bye": "2",
      "game_size": "1v1",
      "created_at_utc": "Sat Jan 08 2011, 22:55 UTC",
      "created_at": 1294527341
    }
  ]
}
      

Users > users/:id/matches top

Get details for all 1v1 matches a user participated in.
  • Attributes
  • - match_id - id of the match
  • - event_id - the tournament id
  • - event_name - name of the match
  • - match_opponent - users opponent in the match
  • - outcome won|lost|TBD - users outcome in the match
  • - score - win-loss record from the prospective of the user
  • - reported_at - when the match was reported
Sample Query
GET http://api.z33k.com/v1/users/545/matches.json
GET http://api.z33k.com/v1/users/545/matches.xml
xml

<hash>
  <matches type="array">
    <match>
      <match-id type="integer">19398</match-id>
      <event-name>NESC2League Invitational</event-name>
      <event-id type="integer">228</event-id>
      <match-opponent>fayde</match-opponent>
      <outcome>lost</outcome>
      <score>0-2 (Forfeit)</score>
      <reported-at-utc nil="true"></reported-at-utc>
      <reported-at type="integer">0</reported-at>
    </match>
    <match>
      <match-id type="integer">9803</match-id>
      <event-name>Koza Cup</event-name>
      <event-id type="integer">133</event-id>
      <match-opponent>dkiller</match-opponent>
      <outcome>lost</outcome>
      <score>0-3</score>
      <reported-at-utc nil="true"></reported-at-utc>
      <reported-at type="integer">0</reported-at>
    </match>
  </matches>
</hash>
json

{
  "matches": [
    {
      "match_id": 19398,
      "event_name": "NESC2League Invitational",
      "event_id": 228,
      "match_opponent": "fayde",
      "outcome": "lost",
      "score": "0-2 (Forfeit)",
      "reported_at_utc": null,
      "reported_at": 0
    },
    {
      "match_id": 9803,
      "event_name": "Koza Cup",
      "event_id": 133,
      "match_opponent": "dkiller",
      "outcome": "lost",
      "score": "0-3",
      "reported_at_utc": null,
      "reported_at": 0
    }
  ]
}
      

Streams

Streams > streams top

A list of all online approved. Attributes are the same as streams/:id Sample Query
GET http://api.z33k.com/v1/streams.json
GET http://api.z33k.com/v1/streams.xml
xml

<streamlist>
  <approved-streams type="array">
    <approved-stream>
      <id type="integer">5813</id>
      <name>Destiny</name>
      <updated-at-utc>Sat Dec 10 2011, 01:44 UTC</updated-at-utc>
      <updated-at type="integer">1323481477</updated-at>
      <description nil="true"></description>
      <live type="boolean">true</live>
      <viewers type="integer">3529</viewers>
      <rating-average nil="true"></rating-average>
      <rating-count nil="true"></rating-count>
      <preview-image>http://img.own3d.tv/live/big_live_tn_153518_.jpg?1329007077</preview-image>
      <source-type>own3d</source-type>
      <source-uid>153518</source-uid>
      <source-username>Destiny</source-username>
      <source-url>http://www.own3d.tv/live/153518</source-url>
    </approved-stream>
    <approved-stream>
      <id type="integer">1790</id>
      <name>IGNProLeague</name>
      <updated-at-utc>Sat Dec 10 2011, 01:44 UTC</updated-at-utc>
      <updated-at type="integer">1323481468</updated-at>
      <description></description>
      <live type="boolean">true</live>
      <viewers type="integer">3332</viewers>
      <rating-average nil="true"></rating-average>
      <rating-count nil="true"></rating-count>
      <preview-image>http://static-cdn.jtvnw.net/previews/live_user_ignproleague-320x240.jpg</preview-image>
      <source-type>justintv</source-type>
      <source-uid>ignproleague</source-uid>
      <source-username nil="true"></source-username>
      <source-url>http://www.justin.tv/ignproleague</source-url>
    </approved-stream>
    <approved-stream>
      <id type="integer">4930</id>
      <name>White-Ra</name>
      <updated-at-utc>Sat Dec 10 2011, 01:44 UTC</updated-at-utc>
      <updated-at type="integer">1323481474</updated-at>
      <description>Entertainment games for SC2 community!!!Many people ask me how they can support my stream, now  its very easy, become the subscriber and you not get any commercial. Thanks twitch.tv for this service.</description>
      <live type="boolean">true</live>
      <viewers type="integer">3320</viewers>
      <rating-average type="float">5.0</rating-average>
      <rating-count type="integer">1</rating-count>
      <preview-image>http://static-cdn.jtvnw.net/previews/live_user_whitera-320x240.jpg</preview-image>
      <source-type>justintv</source-type>
      <source-uid>whitera</source-uid>
      <source-username nil="true"></source-username>
      <source-url>http://www.justin.tv/whitera</source-url>
    </approved-stream>
  </approved-streams>
</streamlist>

json

{
  "streamlist": {
    "approved_streams": [
      {
        "id": 5813,
        "name": "Destiny",
        "updated_at_utc": "Sat Dec 10 2011, 01:44 UTC",
        "updated_at": 1323481477,
        "description": null,
        "live": true,
        "viewers": 3529,
        "rating_average": null,
        "rating_count": null,
        "preview_image": "http://img.own3d.tv/live/big_live_tn_153518_.jpg?1329007148",
        "source_type": "own3d",
        "source_uid": "153518",
        "source_username": "Destiny",
        "source_url": "http://www.own3d.tv/live/153518"
      },
      {
        "id": 1790,
        "name": "IGNProLeague",
        "updated_at_utc": "Sat Dec 10 2011, 01:44 UTC",
        "updated_at": 1323481468,
        "description": "",
        "live": true,
        "viewers": 3332,
        "rating_average": null,
        "rating_count": null,
        "preview_image": "http://static-cdn.jtvnw.net/previews/live_user_ignproleague-320x240.jpg",
        "source_type": "justintv",
        "source_uid": "ignproleague",
        "source_username": null,
        "source_url": "http://www.justin.tv/ignproleague"
      },
      {
        "id": 4930,
        "name": "White-Ra",
        "updated_at_utc": "Sat Dec 10 2011, 01:44 UTC",
        "updated_at": 1323481474,
        "description": "Entertainment games for SC2 community!!!Many people ask me how they can support my stream, now  its very easy, become the subscriber and you not get any commercial. Thanks twitch.tv for this service.",
        "live": true,
        "viewers": 3320,
        "rating_average": 5.0,
        "rating_count": 1,
        "preview_image": "http://static-cdn.jtvnw.net/previews/live_user_whitera-320x240.jpg",
        "source_type": "justintv",
        "source_uid": "whitera",
        "source_username": null,
        "source_url": "http://www.justin.tv/whitera"
      }
    ]
  }
}
      

Streams > streams/:id top

Get extended details for the given stream.
  • Attributes
  • - id - stream id
  • - name
  • - updated_at
  • - description
  • - live true|false - if the stream is online
  • - viewers - current number of viewers
  • - rating_average - average Z33K rating
  • - rating_count - Z33K rating count
  • - preview_image
  • - source_type justintv|livestream|own3d|ustream - the stream provider. note: all twitch.tv streams will have justintv source_type
  • - source_id - the stream's id in the stream provider's system
  • - source_username - stream's user name in the stream provider's system
  • - source_url
Sample Query
GET http://api.z33k.com/v1/streams/4930.json
GET http://api.z33k.com/v1/streams/4930.xml
xml

<hash>
  <stream>
    <id type="integer">4930</id>
    <name>White-Ra</name>
    <updated-at-utc>Sat Dec 10 2011, 01:44 UTC</updated-at-utc>
    <updated-at type="integer">1323481474</updated-at>
    <description>Entertainment games for SC2 community!!!Many people ask me how they can support my stream, now  its very easy, become the subscriber and you not get any commercial. Thanks twitch.tv for this service.</description>
    <live type="boolean">true</live>
    <viewers type="integer">3320</viewers>
    <rating-average type="float">5.0</rating-average>
    <rating-count type="integer">1</rating-count>
    <preview-image>http://static-cdn.jtvnw.net/previews/live_user_whitera-320x240.jpg</preview-image>
    <source-type>justintv</source-type>
    <source-uid>whitera</source-uid>
    <source-username nil="true"></source-username>
    <source-url>http://www.justin.tv/whitera</source-url>
  </stream>
</hash>
json

{
  "stream": {
    "id": 4930,
    "name": "White-Ra",
    "updated_at_utc": "Sat Dec 10 2011, 01:44 UTC",
    "updated_at": 1323481474,
    "description": "Entertainment games for SC2 community!!!Many people ask me how they can support my stream, now  its very easy, become the subscriber and you not get any commercial. Thanks twitch.tv for this service.",
    "live": true,
    "viewers": 3320,
    "rating_average": 5.0,
    "rating_count": 1,
    "preview_image": "http://static-cdn.jtvnw.net/previews/live_user_whitera-320x240.jpg",
    "source_type": "justintv",
    "source_uid": "whitera",
    "source_username": null,
    "source_url": "http://www.justin.tv/whitera"
  }
}