{#TOP's & Rank's#}

GEThttps://wapi.wizebot.tv/api/ranking/{API_KEY}/top/{TOP_TYPE}/{TOP_SUB_TYPE}/{LIMIT}

{#Retrieval of the TOP's of the channel.#}

Request

Path Params

API_KEY

string

required

{#API key (R) of your WizeBot account.#}

Example:

TOP_TYPE

enum<string>

required

{#Type of TOP's to recover#} (uptime, message, currency, ranks, level).

Allowed values:

uptimemessagecurrencyrankslevel

Example:

uptime

TOP_SUB_TYPE

enum<string>

required

{#Subsidiary parameter of recovery#} (week, month, global).
{#Available only for the following TOPs:#} uptime, message.

Allowed values:

weekmonthglobal

Example:

week

LIMIT

integer

required

{#Number of records to retrieve (Numerical value / Maximum: 100).#}

>= 1<= 100

Example:

100

Request samples

Responses

Success(200)

HTTP Code: 200

Content Type : JSONapplication/json

success

boolean

required

list

array [object {3}]

required

{#List of viewers in the TOP ordered from largest (TOP1) to smallest.#}

user_name

string

required

Viewer Name.

user_uid

string

required

value

string

required

code

integer

required

{#The code associated with the request.#}

cache_timestamps

integer

required

{#The timestamps of caching.#}

{
  "success": true,
  "list": [
    {
      "user_name": "player1",
      "user_uid": "1234",
      "value": "202329"
    },
    {
      "user_name": "player2",
      "user_uid": "12345",
      "value": "147261"
    },
    {
      "user_name": "player3",
      "user_uid": "123456",
      "value": "113814"
    }
  ],
  "code": 200,
  "cache_timestamps": 1714788535
}

Last modified: 7 months ago