API documentation

All the informations and details about Worldwide Combos games modes and rankings.

This API is under construction. More features will be added in the future.

In order to use this API, just send a request to https://www.worldwide-combos.com/api/name after replacing name by the method's name.

NameDescription
profileRetrieve a validated player's profile informations
onlineRetrieve the list of players that are currently online.
rankingsRetrieve Worldwide Combos rankings with some optional filters.
official_rulesetsRetrieve a validated player's ranks in official rulesets.

profile

This is to retrieve a validated player's profile informations.

Parameters

NameOptionalDescription
usernamenoThe username of the player you are interested in.

Example: https://www.worldwide-combos.com/api/profile?username=noelnadal.

Response fields

Each response contains a warning field and an error field. If the error attribute is an empty string, then there is another field called profile, which is a collection with the following fields.

NameTypeDescription
usernamestringThe username of the player you queried.
countrystringThe country of the player you queried.
registration_datestringThe registration date and time (UTC) of the player you queried.
last_loginstringThe last time (UTC) the player you queried was online.
ghostbusterfloatThe Ghostbuster rating of the player you queried.
multiplayerfloat[DEPRECATED] The Multiplayer rating of the player you queried.
multiplayer_holesfloat[DEPRECATED] The No Limit Holes Multiplayer rating of the player you queried.
multiplayer_bombsfloat[DEPRECATED] The No Limit Bombs Multiplayer rating of the player you queried.
multiplayer_chaosfloat[DEPRECATED] The No Limit Chaos Multiplayer rating of the player you queried.
multiplayer_holes_nolimitfloatThe No Limit Holes Multiplayer rating of the player you queried.
multiplayer_bombs_nolimitfloatThe No Limit Bombs Multiplayer rating of the player you queried.
multiplayer_chaos_nolimitfloatThe No Limit Chaos Multiplayer rating of the player you queried.
multiplayer_holes_tuninglimitfloatThe Tuning Limit Holes Multiplayer rating of the player you queried.
multiplayer_bombs_tuninglimitfloatThe Tuning Limit Bombs Multiplayer rating of the player you queried.
multiplayer_chaos_tuninglimitfloatThe Tuning Limit Chaos Multiplayer rating of the player you queried.
sprintfloatThe Sprint Personal Best of the player you queried, in seconds.
survivorfloat[DEPRECATED] The Survivor Personal Best of the player you queried, in seconds, if this value is strictly less than 240. If not, it means that this player unlocked the Elite Survivor mode (240 seconds are added to Elite Survivor times).
survivor10float[DEPRECATED] The Survivor 10 score of the player you queried, in seconds
survivor_holesfloatThe Holes Survivor Personal Best of the player you queried, in seconds, if this value is strictly less than 240. If not, it means that this player unlocked the Elite Survivor mode (240 seconds are added to Elite Survivor times).
survivor_holes10floatThe Holes Survivor 10 score of the player you queried, in seconds.
survivor_bombsfloatThe Bombs Survivor Personal Best of the player you queried, in seconds, if this value is strictly less than 240. If not, it means that this player unlocked the Elite Survivor mode (240 seconds are added to Elite Survivor times).
survivor_bombs10floatThe Bombs Survivor 10 score of the player you queried, in seconds.
apmfloatThe average Attack Per Minute of the player you queried, based on the Ghostbuster and Multiplayer games that were played in the last month. If that player hasn't played in the last month, then the value is equal to 0.
bpsfloatThe average Block Per Second of the player you queried, based on the last 20 Multiplayer games they played. If that player hasn't played yet, then the value is equal to 0.
twitchstringThe Twitch channel of the player you queried, if it is public, or an empty string otherwise.
genderstringThe gender of the player you queried, either "Male", "Female", "Other" or "Unknown".
namestringThe name of the player you queried, if it is known, or an empty string otherwise.
surnamestringThe surname of the player you queried, if it is known, or an empty string otherwise.
ghostbuster_rankintegerThe Ghostbuster Rank of the player you queried, if there is one, -1 otherwise.
multiplayer_rankinteger[DEPRECATED] The Multiplayer Rank of the player you queried, if there is one, -1 otherwise.
multiplayer_holes_rankinteger[DEPRECATED] The No Limit Holes Multiplayer Rank of the player you queried, if there is one, -1 otherwise.
multiplayer_bombs_rankinteger[DEPRECATED] The No Limit Bombs Multiplayer Rank of the player you queried, if there is one, -1 otherwise.
multiplayer_chaos_rankinteger[DEPRECATED] The No Limit Chaos Multiplayer Rank of the player you queried, if there is one, -1 otherwise.
multiplayer_holes_nolimit_rankintegerThe No Limit Holes Multiplayer Rank of the player you queried, if there is one, -1 otherwise.
multiplayer_bombs_nolimit_rankintegerThe No Limit Bombs Multiplayer Rank of the player you queried, if there is one, -1 otherwise.
multiplayer_chaos_nolimit_rankintegerThe No Limit Chaos Multiplayer Rank of the player you queried, if there is one, -1 otherwise.
multiplayer_holes_tuninglimit_rankintegerThe Tuning Limit Holes Multiplayer Rank of the player you queried, if there is one, -1 otherwise.
multiplayer_bombs_tuninglimit_rankintegerThe Tuning Limit Bombs Multiplayer Rank of the player you queried, if there is one, -1 otherwise.
multiplayer_chaos_tuninglimit_rankintegerThe Tuning Limit Chaos Multiplayer Rank of the player you queried, if there is one, -1 otherwise.
sprint_rankintegerThe Sprint Rank of the player you queried, if there is one, "-1" otherwise.
survivor_rankinteger[DEPRECATED] The Survivor Rank of the player you queried, if there is one, -1 otherwise.
survivor_holes_rankintegerThe Holes Survivor Rank of the player you queried, if there is one, -1 otherwise.
survivor_bombs_rankintegerThe Bombs Survivor Rank of the player you queried, if there is one, -1 otherwise.

This is what you could get with the query above.

{
 "warning": "WARNING: 'multiplayer', 'multiplayer_rank', 'survivor', 'survivor10', 'survivor_rank', 'tournament' and 'tournament_rank' properties are deprecated and may become unavailable in future API updates.",
 "error": "",
 "profile": {
	"username": "noelnadal",
	"country": "France",
	"registration_date": "Sun Jul 02 2017 22:50:15",
	"last_login": "Sun May 12 2019 18:10:01",
	"ghostbuster": 1073.89,
	"multiplayer": 1213.22,
	"multiplayer_holes": 1213.22,
	"multiplayer_bombs": 900,
	"multiplayer_chaos": 900,
	"tournament": 59.63,
	"sprint": 32.769,
	"survivor": 234.315,
	"survivor10": 1963.154,
	"survivor_holes": 234.315,
	"survivor_holes10": 1963.154,
	"survivor_bombs": 0,
	"survivor_bombs10": 0,
	"apm": 45.631782232849,
	"bps": 1.7612,
	"twitch": "https://twitch.tv/noelnadal",
	"gender": "Male",
	"name": "Nadal",
	"surname": "Noel",
	"ghostbuster_rank": 22,
	"multiplayer_rank": 6,
	"multiplayer_holes_rank": 6,
	"multiplayer_bombs_rank": -1,
	"multiplayer_chaos_rank": -1,
	"tournament_rank": 5,
	"sprint_rank": 37,
	"survivor_rank": 16,
	"survivor_holes_rank": 16,
	"survivor_bombs_rank": -1
 }
}

online

This is to retrieve the list of players that are currently online.

Parameters

None.

Example: https://www.worldwide-combos.com/api/online.

Response fields

Each response contains a warning field and an error field. If the error attribute is an empty string, then the following fields are available as well.

NameTypeDescription
online_users_countintegerThe number of online players.
online_usersarrayAn array with all the currently online users.

Every element in the online_users array is a collection representing one online user and contains the following fields.

NameTypeDescription
usernamestringThe username of the player.
countrystringThe country of the player.

This is what you could get with the query above.

{
 "warning": "",
 "error": "",
 "online_users_count": 2,
 "online_users": [
	{
	  "username": "noelnadal",
	  "country": "France"
	},
	{
	  "username": "Omio9999",
	  "country": "Canada"
	}
 ]
}

rankings

This is to retrieve Worldwide Combos rankings with some optional filters.

Parameters

NameOptionalDescription
typeyesThe rankings you are interested in. This field should take one of these values: multiplayer, ghostbuster, sprint or survivor. The default value is multiplayer.
rulesyesIf the queried ranking is not multiplayer, then this parameter will not be taken into account. Otherwise, this field should take one of these values: holes (DEPRECATED), bombs (DEPRECATED), chaos (DEPRECATED), holes_nolimit, bombs_nolimit, chaos_tuninglimit, holes_nolimit, bombs_tuninglimit, or chaos_tuninglimit. The default value is holes_nolimit.
top10yesIf the queried ranking is multiplayer or ghostbuster then this parameter will not be taken into account. Otherwise, the value should be 1 if you would like to fetch to Top 10 Sprint (resp. Survivor) rankings, and 0 if you would like to fetch the normal Sprint (resp. Survivor) rankings. The default value is 0.
startyesThe rank of the best player that should appear in the query. The default value is 1. In case of ties around the first ranks the players that are chosen to be at those ranks will be chosen arbitrarily.
countyesThe number of players that should appear in the query. The default value is 0, which means that all players until the end appear in the ranking. In case of ties around the last ranks the players that are chosen to be at those ranks will be chosen arbitrarily.

Example: https://www.worldwide-combos.com/api/rankings?type=sprint&top10=1&start=6&count=5.

Response fields

Each response contains a warning field and an error field. If the error attribute is an empty string, then another field is available as well: the rankings field, which is an array where each element represents one player in the queried rankings, described by the following.fields.

NameTypeDescription
rankstringThe rank of the player.
usernamestringThe username of the player.
countrystringThe country of the player.
scorestringThe score of the player, which is used for the ranking (for instance, the Ghostbuster rating in the Ghostbuster ranking).

This is what you could get with the query above.

{
 "warning": "",
 "error": "",
 "rankings": [
	{
	  "rank": 6,
	  "username": "Shan",
	  "country": "New Zealand",
	  "score": 256338
	},
	{
	  "rank": 7,
	  "username": "OnePunMan",
	  "country": "Australia",
	  "score": 257938
	},
	{
	  "rank": 8,
	  "username": "Glasses",
	  "country": "Unknown",
	  "score": 279201
	},
	{
	  "rank": 9,
	  "username": "qmk",
	  "country": "United States",
	  "score": 280992
	},
	{
	  "rank": 10,
	  "username": "Hua",
	  "country": "Taiwan",
	  "score": 288465
	}
 ]
}

official_rulesets

This is to retrieve a validated player's ranks on the official rulesets.

Parameters

NameOptionalDescription
usernamenoThe username of the player you are interested in.

Example: https://www.worldwide-combos.com/api/official_rulesets?username=noelnadal.

Response fields

Each response contains a warning field and an error field. If the error attribute is an empty string, then there are six more fields, respectively called nlh, nlb, nlc, tlh, tlb and tlc, which are collections with the following fields.

NameTypeDescription
pointsstringThe ratings points of the player in this ruleset.
rankstringThe rank of the player.

Each field corresponds to an official ruleset:

  • nlh corresponds to No Limit Holes;
  • nlb corresponds to No Limit Bombs;
  • nlc corresponds to No Limit Chaos;
  • tlh corresponds to Tuning Limit Holes;
  • tlb corresponds to Tuning Limit Bombs;
  • tlc corresponds to Tuning Limit Chaos.

This is what you could get with the query above.

{
  "warning": "",
  "error": "",
  "nlh": {
    "points": 923.11,
    "rank": 28
  },
  "nlb": {
    "points": 873.29,
    "rank": 7
  },
  "nlc": {
    "points": 914.22,
    "rank": 4
  },
  "tlh": {
    "points": 950.29,
    "rank": 4
  },
  "tlb": {
    "points": 950.29,
    "rank": 1
  },
  "tlc": {
    "points": 950.29,
    "rank": 4
  }
}

Worldwide Combos 3.7.1 - Noël Nadal - logo by Legitimate Ted
Privacy policy - Terms and Conditions - Donate - Submit feedback