Twitch · JSON Structure

Twitch User Structure

Structural definition of a Twitch user

Type: object Properties: 11
EntertainmentGamingLive VideoStreamingVideo

Twitch User Structure is a JSON Structure definition published by Twitch, describing 11 properties. It conforms to the https://json-schema.org/draft/2020-12/schema meta-schema.

Properties

id login display_name type broadcaster_type description profile_image_url offline_image_url view_count email created_at

Meta-schema: https://json-schema.org/draft/2020-12/schema

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Twitch User Structure",
  "description": "Structural definition of a Twitch user",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "User's ID"
    },
    "login": {
      "type": "string",
      "description": "User's login name (lowercase)"
    },
    "display_name": {
      "type": "string",
      "description": "User's display name"
    },
    "type": {
      "type": "string",
      "enum": ["admin", "global_mod", "staff", ""],
      "description": "User's type"
    },
    "broadcaster_type": {
      "type": "string",
      "enum": ["affiliate", "partner", ""],
      "description": "Broadcaster type"
    },
    "description": {
      "type": "string",
      "description": "User's channel description"
    },
    "profile_image_url": {
      "type": "string",
      "format": "uri",
      "description": "URL of the user's profile image"
    },
    "offline_image_url": {
      "type": "string",
      "format": "uri",
      "description": "URL of the user's offline image"
    },
    "view_count": {
      "type": "integer",
      "description": "Total number of views of the user's channel"
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "User's email (requires user:read:email scope)"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Date and time the user's account was created"
    }
  }
}