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://modlookup.3v.fi/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
• Errors
• GET /user-v3/:user
• GET /user-totals/:user
• GET /top
• GET /stats

Limits

• No concurrent requests. Wait for your previous request to finish before starting a new one.
• Don't request the same resource more than once every 30 minutes, if you can cache the response in your application. This is the smallest server-side cache duration so you won't get any new data requesting faster than this.

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

Errors

GET /user-v3/:user

Query Parameters

Example

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

GET /user-totals/:user

Example

{
  "status": 200,
  "user": "3v",
  "views": 2952102171,
  "follows": 16154368,
  "total": 74,
  "partners": 19
}

GET /top

Example

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

GET /stats

Example

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