User Endpoints

A user represents a User account on Top.gg. It is not associated with any other platform like Discord.

GET/users/:id

Find One User

Retrieves information about a particular user by their Discord user id.

Response Schema

  • Name
    id
    Type
    snowflake
    Description

    The id of the user

  • Name
    username
    Type
    string
    Description

    The username of the user

  • Name
    discriminator
    Type
    string
    Description

    The discriminator of the user

  • Name
    avatar?
    Type
    string
    Description

    The avatar hash of the user

  • Name
    defAvatar
    Type
    string
    Description

    The default avatar hash of the user

  • Name
    bio?
    Type
    string
    Description

    The bio of the user

  • Name
    banner?
    Type
    string
    Description

    The banner URL of the user

  • Name
    social
    Type
    object
    Description

    The social links of the user

  • Name
    social.youtube
    Type
    string
    Description

    The YouTube channel ID of the user

  • Name
    social.reddit
    Type
    string
    Description

    The Reddit username of the user

  • Name
    social.twitter
    Type
    string
    Description

    The Twitter username of the user

  • Name
    social.instagram
    Type
    string
    Description

    The Instagram username of the user

  • Name
    social.github
    Type
    string
    Description

    The GitHub username of the user

  • Name
    color
    Type
    string
    Description

    The custom hex color of the user (not guaranteed to be valid hex)

  • Name
    supporter
    Type
    boolean
    Description

    The supporter status of the user

  • Name
    certifiedDev
    Type
    boolean
    Description

    The certified status of the user

  • Name
    mod
    Type
    boolean
    Description

    The moderator status of the user

  • Name
    webMod
    Type
    boolean
    Description

    The web moderator status of the user

  • Name
    admin
    Type
    boolean
    Description

    The admin status of the user

Request

https://top.gg/api/users/:id

Response

{
  "avatar": "0e6ce11ca2fefc2c38b1099d66ad66b5",
  "id": "121919449996460033",
  "username": "veld",
  "defAvatar": "0e6ce11ca2fefc2c38b1099d66ad66b5",
  "admin": true,
  "webMod": true,
  "mod": true,
  "certifiedDev": true,
  "supporter": true
}