Create a tournament
Create a tournament
Create a new tournament.
URL
POST
https://api.challonge.com/v1/tournaments.{json|xml}
Parameters
| Name | Description |
|---|---|
|
Obligatorisk
api_key
|
Your API key (required unless you're using HTTP basic authentication) |
tournament[name]
|
Your event's name/title (Max: 60 characters) |
tournament[tournament_type]
|
Single elimination (default), double elimination, round robin, swiss |
tournament[url]
|
challonge.com/url (letters, numbers, and underscores only); when blank on create, a random URL will be generated for you |
tournament[subdomain]
|
subdomain.challonge.com/url (Requires write access to the specified subdomain) |
tournament[description]
|
Description/instructions to be displayed above the bracket |
tournament[open_signup]
|
True or false. Have Challonge host a sign-up page (otherwise, you manually add all participants) |
tournament[hold_third_place_match]
|
True or false - Single Elimination only. Include a match between semifinal losers? (default: false) |
tournament[pts_for_match_win]
|
Decimal (to the nearest tenth) - Swiss only - default: 1.0 |
tournament[pts_for_match_tie]
|
Decimal (to the nearest tenth) - Swiss only - default: 0.5 |
tournament[pts_for_game_win]
|
Decimal (to the nearest tenth) - Swiss only - default: 0.0 |
tournament[pts_for_game_tie]
|
Decimal (to the nearest tenth) - Swiss only - default: 0.0 |
tournament[pts_for_bye]
|
Decimal (to the nearest tenth) - Swiss only - default: 1.0 |
tournament[swiss_rounds]
|
Integer - Swiss only - We recommend limiting the number of rounds to less than two-thirds the number of players. Otherwise, an impossible pairing situation can be reached and your tournament may end before the desired number of rounds are played. |
tournament[ranked_by]
|
One of the following: 'match wins', 'game wins', 'points scored', 'points difference', 'custom'
|
tournament[rr_pts_for_match_win]
|
Decimal (to the nearest tenth) - Round Robin "custom only" - default: 1.0 |
tournament[rr_pts_for_match_tie]
|
Decimal (to the nearest tenth) - Round Robin "custom" only - default: 0.5 |
tournament[rr_pts_for_game_win]
|
Decimal (to the nearest tenth) - Round Robin "custom" only - default: 0.0 |
tournament[rr_pts_for_game_tie]
|
Decimal (to the nearest tenth) - Round Robin "custom" only - default: 0.0 |
tournament[accept_attachments]
|
True or false - Allow match attachment uploads (default: false) |
tournament[hide_forum]
|
True or false - Hide the forum tab on your Challonge page (default: false) |
tournament[show_rounds]
|
True or false - Single & Double Elimination only - Label each round above the bracket (default: false) |
tournament[private]
|
True or false - Hide this tournament from the public browsable index and your profile (default: false) |
tournament[notify_users_when_matches_open]
|
True or false - Email registered Challonge participants when matches open up for them (default: false) |
tournament[notify_users_when_the_tournament_ends]
|
True or false - Email registered Challonge participants the results when this tournament ends (default: false) |
tournament[sequential_pairings]
|
True or false - Instead of traditional seeding rules, make pairings by going straight down the list of participants. First round matches are filled in top to bottom, then qualifying matches (if applicable). (default: false) |
tournament[signup_cap]
|
Integer - Maximum number of participants in the bracket. A waiting list (attribute on Participant) will capture participants once the cap is reached. |
tournament[start_at]
|
Datetime - the planned or anticipated start time for the tournament (Used with check_in_duration to determine participant check-in window). Timezone defaults to Eastern. |
tournament[check_in_duration]
|
Integer - Length of the participant check-in window in minutes. |
tournament[grand_finals_modifier]
|
String - This option only affects double elimination. null/blank (default) - give the winners bracket finalist two chances to beat the losers bracket finalist, 'single match' - create only one grand finals match, 'skip' - don't create a finals match between winners and losers bracket finalists |
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": null,
"started_checking_in_at": null,
"state": "pending",
"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 nil="true"/>
<started-checking-in-at nil="true"/>
<state>pending</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>