Introduction

The API is free to use, though I ask you provide a custom user-agent with a URL to your application or a page describing it, if used outside client-side javascript. The base URL is https://twitchstuff.3v.fi/modlookup/api/. Keep in mind the channel mod lists are only updated once a day. Only documented endpoints can be used without prior contact.

Contents

Limits

If your application needs to exceed these limits, please contact me.

Errors

StatusDescription
400 Bad RequestThe request was malformed and could not be completed. See the returned json.error for details.
403 ForbiddenYou have been blocked.
500 Internal Server ErrorThe request could not be completed due to a server error. Try again later.
502 Bad GatewayThe backend is currently unreachable. Try again later.
504 Gateway Time-outThe backend could not be reached in time. Try again later.

GET /user/:user

Query Parameters

NameValuesDefault Value
offsetint >= 00
limit1-500100

Example

{
  "status": 200,
  "user": "totallynotventic",
  "count": 2,
  "channels": [
    {
      "name": "3v",
      "followers": 1044,
      "views": 4264,
      "partnered": false
    },
    {
      "name": "ohbot",
      "followers": 134,
      "views": 2217,
      "partnered": false
    }
  ]
}

GET /top

Example

{
  "status: 200,
  "top": {
    "modcount": [
      {
        "name": "3v",
        "modcount": 1337,
        "views": 420,
        "followers": 69
      },
      ...
    ],
    "views": [ ... ]
    "followers": [ ... ]
  }
}

GET /stats

Example

{
  "status: 200,
  "stats": {
    "relations": 10812918,
    "channels_total": 4056799,
    "users": 4386605,
    "channels_no_mods": 331,
    "channels_only_broadcaster": 39564
  }
}