External API Documentation
You can also view this page in the following Languages
![]() |
Contents:
|
English
Introduction
These APIs expose the ability to an external website to pull data out of Voobly. E.g.: A website might want to display the top 10 rated users on a particular ladder.
As explained in PageNotFound an access key is required for use with this APIs. For more information on that topic please review that page
API Documentation
The following list of APIs is a limited subset of we eventually plan to expose (recorded games, team information, etc). The easiest way to get something added here if you want it is to request it on the forums.
All the APIs are located at a path like a following. Not that they all take the developer key as a parameter.
http://www.voobly.com/api/apiname?key=XXXXXXXXXXXXXX
validation
Checks whether the developer key is valid
Example URI:
http://www.voobly.com/api/validate?key=XXXXXXXXXXXXXX
Example output:
valid-key
user/$userid
Get information on a user
Example URI:
http://www.voobly.com/api/user/23?key=XXXXXXXXXXXXXX
Example output:
uid,display_name,name,account_created,last_login,sex,nationid,bday,bmonth,byear,level,nation,imagelarge,imagesmall,tid
23,Elusive,Elusive,1182149865,1255417337,0,ca,1,1,1950,29,Canada,/files/view/7068/3zy8h2kp3qq5ed3is2c37nw00uw3noyo,/files/view/65009/w57tdcefdmhsz7uvc4brqxyz8dpe0tgo,
ladder/$ladderid
Get ladder information. The following example spews out the top 40 ranked players. To get a specific player add &uid=123 to the URI where 123 is the user (example #2). Other extended features:
-
uidlist=1,2,3 - Returns results for user id 1, 2, and 3 (do not mix with uid)
start=?? player rank to start at
limit=?? limit result to ?? lines (max is 40)
Example URI:
http://www.voobly.com/api/ladder/10?key=XXXXXXXXXXXXXX
Example output:
rank,uid,display_name,rating,wins,losses,streak
-
1,21919,[Gx]13r1aN,2548,610,291,1
2,19015,Ominous1,2468,260,109,-3
3,145370,DaGhostInside,2451,561,67,3
4,74548,[1M]BabyILoveYou,2437,279,154,11
5,1655,[Berry]Geenberry,2428,266,50,8
6,117460,[Berry]CHE_dd,2427,309,42,-2
7,63247,BmW_2,2402,262,43,25
8,887,Az,2375,426,173,1
9,65162,[HTR]_AxEL,2355,96,19,8
10,10199,sammyzheng,2325,474,695,2
11,1708,MMO_Executioner,2323,340,57,1
12,89130,NightBluE,2311,280,293,-1
etc
Example URI #2:
http://www.voobly.com/api/ladder/10?key=XXXXXXXXXXXXXX&uid=23
Example output #2:
rank,uid,display_name,rating,wins,losses,streak
1,23,Elusive,1679,26,15,1
finduser/$displayname
Lookup a uid from a display name
Example URI:
http://www.voobly.com/api/finduser/elusive?key=XXXXXXXXXXXXXX
Example output:
uid
23
findusers/$displayname,$displayname2,$displayname3,...
Lookup a list of userids from a list display names
Example URI:
http://www.voobly.com/api/finduser/elusive,someuser,xmx_elite?key=XXXXXXXXXXXXXX
Example output:
name,uid
elusive,1
someuser,
xmx_elite,17
In the above example elusive and xmx_elite are valid users names. Whereas, someuser is not.
lobbies/$gameid
Lookup a list of lobbies for a game
Example URI:
http://www.voobly.com/api/lobbies/13?key=XXXXXXXXXXXXXX
Example output:
lobbyid,name,players_online,max_players,ladders
-
64,Medieval Siege (RM),517,1000,21|8|14|13|
67,Tours (RM),1,350,21|8|14|13|
66,Agincourt (RM),0,350,21|8|14|13|
65,Uneasy Alliances (RM),0,350,21|8|14|13|
69,Custom Scenario,449,1000,20|16|17|18|19|15|
68,Deathmatch,73,350,9|
71,CS League,0,300,
70,Tournament Lobby,0,300,
129,1v1 Random Map,12,1000,13|
90,Random Map: Unrated,2,1000,
91,Custom Scenario: Unrated,0,1000,
Example Usage
TODO - Post a sample PHP script
Spanish
Documentación de la API externa
Introducción
Estas APIs expone la capacidad de un sitio web externo para extraer los datos fuera de voobly. Por ejemplo: un sitio web que desee mostrar el top 10 de los usuarios de una determinada escalera.
Como se ha explicado en PageNotFound una clave de acceso es necesaria para el uso de estas APIs. Para obtener más información sobre este tema por favor, re-lea esa página
API Documentación
La siguiente lista de APIs es un subconjunto limitado de lo que eventualmente vamos a exponer (Partidas grabados, información sobre el equipo, etc.) La manera más fácil de obtener que algo mas se añada aquí, si desea que se haga, pon una solicitud en los foros.
Todas las APIs están ubicados en una ruta como la siguiente, lo cual no significa que todos ellos tienen la clave de desarrollo como un parámetro.
http://www.voobly.com/api/apiname?key=XXXXXXXXXXXXXX
Validación
Comprueba si la clave del desarrollador es válida.
Ejemplo URI:
http://www.voobly.com/api/validate?key=XXXXXXXXXXXXXX
Ejemplo de salida:
valid-key
user/$userid
Obtener información sobre un usuario.
Ejemplo URI:
http://www.voobly.com/api/user/23?key=XXXXXXXXXXXXXX
Ejemplo de salida:
uid,display_name,name,account_created,last_login,sex,nationid,bday,bmonth,byear,level,nation,imagelarge,imagesmall,tid
23,Elusive,Elusive,1182149865,1255417337,0,ca,1,1,1950,29,Canada,/files/view/7068/3zy8h2kp3qq5ed3is2c37nw00uw3noyo,/files/view/65009/w57tdcefdmhsz7uvc4brqxyz8dpe0tgo,
ladder/$ladderid
Obtener información escalera. El ejemplo siguiente sabrá los 40 mejores jugadores clasificados.
Para obtener un jugador en específico agregar &uid=123 a la URI donde 123 es el usuario (ejemplo #2). Otras características:
-
uidlist=1,2,3 - Devuelve los resultados para el usuario id 1, 2, y 3 (No mezclar con uid)
start=?? Rango jugador para comenzar a
limit=?? limit result to ?? lines (max is 40)
Example URI:
http://www.voobly.com/api/ladder/10?key=XXXXXXXXXXXXXX
Ejemplo Salida:
rank,uid,display_name,rating,wins,losses,streak
-
1,21919,[Gx]13r1aN,2548,610,291,1
2,19015,Ominous1,2468,260,109,-3
3,145370,DaGhostInside,2451,561,67,3
4,74548,[1M]BabyILoveYou,2437,279,154,11
5,1655,[Berry]Geenberry,2428,266,50,8
6,117460,[Berry]CHE_dd,2427,309,42,-2
7,63247,BmW_2,2402,262,43,25
8,887,Az,2375,426,173,1
9,65162,[HTR]_AxEL,2355,96,19,8
10,10199,sammyzheng,2325,474,695,2
11,1708,MMO_Executioner,2323,340,57,1
12,89130,NightBluE,2311,280,293,-1
etc
Ejemplo URI #2:
http://www.voobly.com/api/ladder/10?key=XXXXXXXXXXXXXX&uid=23
Ejemplo salida #2:
rank,uid,display_name,rating,wins,losses,streak
1,23,Elusive,1679,26,15,1
finduser/$displayname
buscar un uid de un nombre a mostrar
Ejemplo URI:
http://www.voobly.com/api/finduser/elusive?key=XXXXXXXXXXXXXX
Ejemplo salida:
uid
23
findusers/$displayname,$displayname2,$displayname3,...
Buscar una lista de id de la lista nombres de visualización.
Ejemplo URI:
http://www.voobly.com/api/finduser/elusive,someuser,xmx_elite?key=XXXXXXXXXXXXXX
Ejemplo salida:
name,uid
elusive,1
someuser,
xmx_elite,17
En el ejemplo anterior elusive and xmx_elite son nombres de usuarios válidos En cambio, someuser alguien no lo es.
lobbies/$gameid
Buscar una lista de los grupos de juego.
Ejemplo URI:
http://www.voobly.com/api/lobbies/13?key=XXXXXXXXXXXXXX
Ejemplo de salida:
lobbyid,name,players_online,max_players,ladders
-
64,Medieval Siege (RM),517,1000,21|8|14|13|
67,Tours (RM),1,350,21|8|14|13|
66,Agincourt (RM),0,350,21|8|14|13|
65,Uneasy Alliances (RM),0,350,21|8|14|13|
69,Custom Scenario,449,1000,20|16|17|18|19|15|
68,Deathmatch,73,350,9|
71,CS League,0,300,
70,Tournament Lobby,0,300,
129,1v1 Random Map,12,1000,13|
90,Random Map: Unrated,2,1000,
91,Custom Scenario: Unrated,0,1000,
Ejemplo de Uso
TODO - Postear un ejemplo de script de PHP
  |
1 User(s) are reading this document (in the past 30 minutes)
0 members, 1 guests
0 members, 1 guests
What's popular right now:








[ Epic_] v [FIz ] (77 users)

Europe 2v2 : Sign Ups (64 users)

AoKTS updates (52 users)

CBA Hero 3v3 : Results (41 users)

CBA PathBlood 1.8.2 (39 users)

CBA Hero 1v1 : Brackets (36 users)

1.6 reward campaing (36 users)
Most active threads in past week:








Fast proxy detection problem (9 posts)

Fp with some people (9 posts)

1.6 new bug Feb 25 (5 posts)

Bug multiple tec + otros errores (3 posts)

AI in Multiplayer RESIGNS too so... (2 posts)

MESSENGER CLIENT CRASH GAMES (2 posts)

I HAVE A PROBLEM (2 posts)