Help Center > Voobly Developer Center > External API Documentation

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 Developer Membership Types 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.

Example Usage

TODO - Post a sample PHP script

---

Last updated on October 18, 2009 by [UB]Elusive