Advertisement
Advertisement

Check out Challonge Connect, our new Tournament API Devkit for your Game, Website, or App.

Learn More ×

List a tournament's matches (index)

Advertisement

Retrieve a tournament's match list.


URL

GET https://api.challonge.com/v1/tournaments/{tournament}/matches.{json|xml}

Parameters

Name Description
Necessário
api_key
Your API key (required unless you're using HTTP basic authentication)
Necessário
{tournament} (in URL string)
Tournament ID (e.g. 10230) or URL (e.g. 'single_elim' for challonge.com/single_elim). If assigned to a subdomain, URL format must be :subdomain-:tournament_url (e.g. 'test-mytourney' for test.challonge.com/mytourney)
state all (default), pending, open, complete
participant_id Only retrieve matches that include the specified participant.

Sample Response

[
  {
    "match": {
      "attachment_count": null,
      "created_at": "2015-01-19T16:57:17-05:00",
      "group_id": null,
      "has_attachment": false,
      "id": 23575258,
      "identifier": "A",
      "location": null,
      "loser_id": null,
      "player1_id": 16543993,
      "player1_is_prereq_match_loser": false,
      "player1_prereq_match_id": null,
      "player1_votes": null,
      "player2_id": 16543997,
      "player2_is_prereq_match_loser": false,
      "player2_prereq_match_id": null,
      "player2_votes": null,
      "round": 1,
      "scheduled_time": null,
      "started_at": "2015-01-19T16:57:17-05:00",
      "state": "open",
      "tournament_id": 1086875,
      "underway_at": null,
      "updated_at": "2015-01-19T16:57:17-05:00",
      "winner_id": null,
      "prerequisite_match_ids_csv": "",
      "scores_csv": ""
    }
  },
  {
    "match": {
      "attachment_count": null,
      "created_at": "2015-01-19T16:57:17-05:00",
      "group_id": null,
      "has_attachment": false,
      "id": 23575259,
      "identifier": "B",
      "location": null,
      "loser_id": null,
      "player1_id": 16543994,
      "player1_is_prereq_match_loser": false,
      "player1_prereq_match_id": null,
      "player1_votes": null,
      "player2_id": 16543996,
      "player2_is_prereq_match_loser": false,
      "player2_prereq_match_id": null,
      "player2_votes": null,
      "round": 1,
      "scheduled_time": null,
      "started_at": "2015-01-19T16:57:17-05:00",
      "state": "open",
      "tournament_id": 1086875,
      "underway_at": null,
      "updated_at": "2015-01-19T16:57:17-05:00",
      "winner_id": null,
      "prerequisite_match_ids_csv": "",
      "scores_csv": ""
    }
  },
  {
    "match": {
      "attachment_count": null,
      "created_at": "2015-01-19T16:57:17-05:00",
      "group_id": null,
      "has_attachment": false,
      "id": 23575260,
      "identifier": "C",
      "location": null,
      "loser_id": null,
      "player1_id": null,
      "player1_is_prereq_match_loser": false,
      "player1_prereq_match_id": 23575258,
      "player1_votes": null,
      "player2_id": null,
      "player2_is_prereq_match_loser": false,
      "player2_prereq_match_id": 23575259,
      "player2_votes": null,
      "round": 2,
      "scheduled_time": null,
      "started_at": null,
      "state": "pending",
      "tournament_id": 1086875,
      "underway_at": null,
      "updated_at": "2015-01-19T16:57:17-05:00",
      "winner_id": null,
      "prerequisite_match_ids_csv": "23575258,23575259",
      "scores_csv": ""
    }
  }
]
<?xml version="1.0" encoding="UTF-8"?>
<matches type="array">
  <match>
    <attachment-count nil="true"/>
    <created-at>2015-01-19T16:57:17-05:00</created-at>
    <group-id nil="true"/>
    <has-attachment type="boolean">false</has-attachment>
    <id type="integer">23575258</id>
    <identifier>A</identifier>
    <location nil="true"/>
    <loser-id nil="true"/>
    <player1-id type="integer">16543993</player1-id>
    <player1-is-prereq-match-loser type="boolean">false</player1-is-prereq-match-loser>
    <player1-prereq-match-id nil="true"/>
    <player1-votes nil="true"/>
    <player2-id type="integer">16543997</player2-id>
    <player2-is-prereq-match-loser type="boolean">false</player2-is-prereq-match-loser>
    <player2-prereq-match-id nil="true"/>
    <player2-votes nil="true"/>
    <round type="integer">1</round>
    <scheduled-time nil="true"/>
    <started-at>2015-01-19T16:57:17-05:00</started-at>
    <state>open</state>
    <tournament-id type="integer">1086875</tournament-id>
    <underway-at nil="true"/>
    <updated-at>2015-01-19T16:57:17-05:00</updated-at>
    <winner-id nil="true"/>
    <prerequisite-match-ids-csv></prerequisite-match-ids-csv>
    <scores-csv></scores-csv>
  </match>
  <match>
    <attachment-count nil="true"/>
    <created-at>2015-01-19T16:57:17-05:00</created-at>
    <group-id nil="true"/>
    <has-attachment type="boolean">false</has-attachment>
    <id type="integer">23575259</id>
    <identifier>B</identifier>
    <location nil="true"/>
    <loser-id nil="true"/>
    <player1-id type="integer">16543994</player1-id>
    <player1-is-prereq-match-loser type="boolean">false</player1-is-prereq-match-loser>
    <player1-prereq-match-id nil="true"/>
    <player1-votes nil="true"/>
    <player2-id type="integer">16543996</player2-id>
    <player2-is-prereq-match-loser type="boolean">false</player2-is-prereq-match-loser>
    <player2-prereq-match-id nil="true"/>
    <player2-votes nil="true"/>
    <round type="integer">1</round>
    <scheduled-time nil="true"/>
    <started-at>2015-01-19T16:57:17-05:00</started-at>
    <state>open</state>
    <tournament-id type="integer">1086875</tournament-id>
    <underway-at nil="true"/>
    <updated-at>2015-01-19T16:57:17-05:00</updated-at>
    <winner-id nil="true"/>
    <prerequisite-match-ids-csv></prerequisite-match-ids-csv>
    <scores-csv></scores-csv>
  </match>
  <match>
    <attachment-count nil="true"/>
    <created-at>2015-01-19T16:57:17-05:00</created-at>
    <group-id nil="true"/>
    <has-attachment type="boolean">false</has-attachment>
    <id type="integer">23575260</id>
    <identifier>C</identifier>
    <location nil="true"/>
    <loser-id nil="true"/>
    <player1-id nil="true"/>
    <player1-is-prereq-match-loser type="boolean">false</player1-is-prereq-match-loser>
    <player1-prereq-match-id type="integer">23575258</player1-prereq-match-id>
    <player1-votes nil="true"/>
    <player2-id nil="true"/>
    <player2-is-prereq-match-loser type="boolean">false</player2-is-prereq-match-loser>
    <player2-prereq-match-id type="integer">23575259</player2-prereq-match-id>
    <player2-votes nil="true"/>
    <round type="integer">2</round>
    <scheduled-time nil="true"/>
    <started-at nil="true"/>
    <state>pending</state>
    <tournament-id type="integer">1086875</tournament-id>
    <underway-at nil="true"/>
    <updated-at>2015-01-19T16:57:17-05:00</updated-at>
    <winner-id nil="true"/>
    <prerequisite-match-ids-csv>23575258,23575259</prerequisite-match-ids-csv>
    <scores-csv></scores-csv>
  </match>
</matches>