Loading...

Tukui API Docs

What can you query with our API?

Get addons from our network

URL Example for live:

https://www.tukui.org/api.php?addon=3

URL Example for classic:

https://www.tukui.org/api.php?classic-addon=3
Field Type Description
id string return ID number of addon.
name string return the title of addon.
small_desc string return a condensed description of addon for small area.
author string return the author username.
version string return latest version of the addon uploaded on our network.
screenshot_url string return a screenshot url of the addon.
category string return the main category where the addon is located.
downloads string return the total number of downloads of this addon.
lastupdate string return the last time the addon was updated.
patch string return which World of Warcraft patch this addon is compatible with.
web_url string return url of the addon if an user want to visit his official download web page on our website.
last_download string return when the addon was downloaded for the last time.
donate_url string return a donate url if the addon author accept donations.

Example response

{
    "id": "3",
    "name": "AddOnSkins",
    "small_desc": "Skins for AddOns",
    "author": "Azilroka",
    "version": "3.53",
    "screenshot_url": "https://www.tukui.org/3",
    "url": "https://www.tukui.org/addons.php?download=3",
    "category": "Skins",
    "downloads": "46156",
    "lastupdate": "2017-09-09 07:09:10",
    "patch": "7.2.5",
    "last_download": "2017-09-14 15:20:22",
    "web_url": "https://www.tukui.org/addons.php?id=3",
    "donate_url": "https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=TENQSTDX5SEWE"
}

Want to query all addons from our network?

Live:

https://www.tukui.org/api.php?addons=all

Classic:

https://www.tukui.org/api.php?classic-addons=all

User Authentification with password encryption

URL Example

https://www.tukui.org/api.php?username=Test&password=8g2gyezj7nP45SVmvaszxg==
Field Type Description
status string return if user successfuly logged in.
error string return error code if login failed.
message string return an error message associated with the current error code if any.
username string return the username.
rank string return the current rank of the user.
warnings string return total number of warnings this user have from moderators and admins of Tukui.
posts string return the total number of posts the user made on our website.
regdate string return when the user registrated on our network.
email string return the user email address registrated with this website.
color string return user rank color in HEX format.
privmsg string return 1 you have unread message in your inbox, otherwise 0.
avatar string return the user avatar url.
ip string return the ip address of the user.
birthday string return birthday of the user.

Example response for OK status

{
    "status": "OK",
    "username": "Test",
    "rank": "Member",
    "warnings": "0",
    "posts": "0",
    "regdate": "August 3, 2017, 6:46 pm",
    "email": "email@example.com",
    "color": "#00B3FF",
    "privmsg": "1",
    "avatar": "https://www.tukui.org/images/default-avatar.png",
    "ip": "127.0.0.1",
    "birthday": ""
}

Example response for Error status

{
    "status": "ERROR",
    "error_code": "LOGIN_ERROR_PASSWORD",
    "message": "Incorrect password"
}

Optional Query String Parameters

encrypt-password=false This should be used for development purpose only. With this parameter you can send passwords in plain text.