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.

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

In any case, the answer contains a warning field and an error field. If the latter one 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 of the player you queried.
last_loginstringThe last time the player you queried was online.
ghostbusterfloatThe Ghostbuster rating of the player you queried.
multiplayerfloatThe Multiplayer rating of the player you queried.
tournamentfloat[DEPRECATED] The Tournament points of the player you queried.
sprintfloatThe Sprint Personal Best of the player you queried, in seconds.
survivorfloatThe 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).
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_rankintegerThe Multiplayer Rank of the player you queried, if there is one, "-1" otherwise.
tournament_rankinteger[DEPRECATED] The Tournament 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_rankintegerThe Survivor Rank of the player you queried, if there is one, "-1" otherwise.

This is what you could get with the query above.

{
  "warning": "",
  "error": "",
  "profile": {
    "username": "noelnadal",
    "country": "France",
    "registration_date": "Sun Jul 02 2017 22:50:15",
    "last_login": "Sun May 13 2018 15:41:26",
    "ghostbuster": 1092.1,
    "multiplayer": 1219.74,
    "tournament": 47.41,
    "sprint": 32.769,
    "survivor": 194.636,
    "apm":  45.72,
    "twitch": "https://twitch.tv/noelnadal",
    "gender": "Male",
    "name": "Nadal",
    "surname": "Noel",
    "ghostbuster_rank": 14,
    "multiplayer_rank": 6,
    "tournament_rank": 6,
    "sprint_rank": 17,
    "survivor_rank": 10
  }
}

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

In any case, the answer contains a warning field and an error field. If the latter one 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 represents 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. If this field is not specified then the server will return the multiplayer rankings.
top10yesIf the queried ranking is multiplayer or ghostbuster then this parameter is 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

In any case, the answer contains a warning field and an error field. If the latter one 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
    }
  ]
}

Worldwide Combos 0.10.35 - Noël Nadal - logo by Legitimate Ted
Privacy policy - Acknowledgements - Submit feedback