Get a tournament (show)
Get a tournament (show)
Retrieve a single tournament record created with your account.
URL
GET
https://api.challonge.com/v1/tournaments/{tournament}.{json|xml}
Parameters
| Name | Description |
|---|---|
|
Required
api_key
|
Your API key (required unless you're using HTTP basic authentication) |
|
Required
{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)
|
include_participants
|
0 or 1; includes an array of associated participant records |
include_matches
|
0 or 1; includes an array of associated match records |
Sample Response
{
"tournament": {
"accept_attachments": false,
"allow_participant_match_reporting": true,
"anonymous_voting": false,
"category": null,
"check_in_duration": null,
"completed_at": null,
"created_at": "2015-01-19T16:47:30-05:00",
"created_by_api": false,
"credit_capped": false,
"description": "",
"game_id": 600,
"group_stages_enabled": false,
"hide_forum": false,
"hide_seeds": false,
"hold_third_place_match": false,
"id": 1086875,
"max_predictions_per_user": 1,
"name": "Sample Tournament 1",
"notify_users_when_matches_open": true,
"notify_users_when_the_tournament_ends": true,
"open_signup": false,
"participants_count": 4,
"prediction_method": 0,
"predictions_opened_at": null,
"private": false,
"progress_meter": 0,
"pts_for_bye": "1.0",
"pts_for_game_tie": "0.0",
"pts_for_game_win": "0.0",
"pts_for_match_tie": "0.5",
"pts_for_match_win": "1.0",
"quick_advance": false,
"ranked_by": "match wins",
"require_score_agreement": false,
"rr_pts_for_game_tie": "0.0",
"rr_pts_for_game_win": "0.0",
"rr_pts_for_match_tie": "0.5",
"rr_pts_for_match_win": "1.0",
"sequential_pairings": false,
"show_rounds": true,
"signup_cap": null,
"start_at": null,
"started_at": "2015-01-19T16:57:17-05:00",
"started_checking_in_at": null,
"state": "underway",
"swiss_rounds": 0,
"teams": false,
"tie_breaks": [
"match wins vs tied",
"game wins",
"points scored"
],
"tournament_type": "single elimination",
"updated_at": "2015-01-19T16:57:17-05:00",
"url": "sample_tournament_1",
"description_source": "",
"subdomain": null,
"full_challonge_url": "http://challonge.com/sample_tournament_1",
"live_image_url": "http://images.challonge.com/sample_tournament_1.png",
"sign_up_url": null,
"review_before_finalizing": true,
"accepting_predictions": false,
"participants_locked": true,
"game_name": "Table Tennis",
"participants_swappable": false,
"team_convertable": false,
"group_stages_were_started": false
}
}
<?xml version="1.0" encoding="UTF-8"?>
<tournament>
<accept-attachments type="boolean">false</accept-attachments>
<allow-participant-match-reporting type="boolean">true</allow-participant-match-reporting>
<anonymous-voting type="boolean">false</anonymous-voting>
<category nil="true"/>
<check-in-duration nil="true"/>
<completed-at nil="true"/>
<created-at>2015-01-19T16:47:30-05:00</created-at>
<created-by-api type="boolean">false</created-by-api>
<credit-capped type="boolean">false</credit-capped>
<description></description>
<game-id type="integer">600</game-id>
<group-stages-enabled type="boolean">false</group-stages-enabled>
<hide-forum type="boolean">false</hide-forum>
<hide-seeds type="boolean">false</hide-seeds>
<hold-third-place-match type="boolean">false</hold-third-place-match>
<id type="integer">1086875</id>
<max-predictions-per-user type="integer">1</max-predictions-per-user>
<name>Sample Tournament 1</name>
<notify-users-when-matches-open type="boolean">true</notify-users-when-matches-open>
<notify-users-when-the-tournament-ends type="boolean">true</notify-users-when-the-tournament-ends>
<open-signup type="boolean">false</open-signup>
<participants-count type="integer">4</participants-count>
<prediction-method type="integer">0</prediction-method>
<predictions-opened-at nil="true"/>
<private type="boolean">false</private>
<progress-meter type="integer">0</progress-meter>
<pts-for-bye>1.0</pts-for-bye>
<pts-for-game-tie>0.0</pts-for-game-tie>
<pts-for-game-win>0.0</pts-for-game-win>
<pts-for-match-tie>0.5</pts-for-match-tie>
<pts-for-match-win>1.0</pts-for-match-win>
<quick-advance type="boolean">false</quick-advance>
<ranked-by>match wins</ranked-by>
<require-score-agreement type="boolean">false</require-score-agreement>
<rr-pts-for-game-tie>0.0</rr-pts-for-game-tie>
<rr-pts-for-game-win>0.0</rr-pts-for-game-win>
<rr-pts-for-match-tie>0.5</rr-pts-for-match-tie>
<rr-pts-for-match-win>1.0</rr-pts-for-match-win>
<sequential-pairings type="boolean">false</sequential-pairings>
<show-rounds type="boolean">true</show-rounds>
<signup-cap nil="true"/>
<start-at nil="true"/>
<started-at>2015-01-19T16:57:17-05:00</started-at>
<started-checking-in-at nil="true"/>
<state>underway</state>
<swiss-rounds type="integer">0</swiss-rounds>
<teams type="boolean">false</teams>
<tie-breaks type="array">
<tie-break>match wins vs tied</tie-break>
<tie-break>game wins</tie-break>
<tie-break>points scored</tie-break>
</tie-breaks>
<tournament-type>single elimination</tournament-type>
<updated-at>2015-01-19T16:57:17-05:00</updated-at>
<url>sample_tournament_1</url>
<description-source></description-source>
<subdomain nil="true"/>
<full-challonge-url>http://challonge.com/sample_tournament_1</full-challonge-url>
<live-image-url>http://images.challonge.com/sample_tournament_1.png</live-image-url>
<sign-up-url nil="true"/>
<review-before-finalizing type="boolean">true</review-before-finalizing>
<accepting-predictions type="boolean">false</accepting-predictions>
<participants-locked type="boolean">true</participants-locked>
<game-name>Table Tennis</game-name>
<participants-swappable type="boolean">false</participants-swappable>
<team-convertable type="boolean">false</team-convertable>
<group-stages-were-started type="boolean">false</group-stages-were-started>
</tournament>