unicum.gg Streamers API

openapi: 3.2.0
info:
  title: unicum.gg Streamers API
  version: 0.1.0
  description: Free World of Tanks stats for every player, clan and tank across EU, NA and Asia. WN8, WNX, winrate, tank progression, clan member rankings and history.
servers:
- url: https://unicum.gg/api
security: []
tags:
- name: Streamers
  x-displayName: Streamers
paths:
  /streamers/live:
    get:
      operationId: get-streamers-live
      summary: Live streamers
      description: Tracked players currently live on Twitch, across all regions, with their WN7/WN8/WNX ratings. Snapshot form of the `/streamers/live/sse` stream; cached ~30s server-side.
      tags:
      - Streamers
      parameters: []
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LiveStreamersResponse'
  /streamers/live/sse:
    get:
      operationId: get-streamers-live-sse
      summary: Live streamers stream
      description: Server-sent events (SSE) of the tracked players currently live on Twitch in the World of Tanks category across all regions, ranked by WNX and pushed every few seconds. Each event's `data` is the same JSON array as `GET /api/streamers/live`.
      tags:
      - Streamers
      parameters: []
      responses: {}
  /twitch/{login}/badges:
    get:
      operationId: get-twitch-{login}-badges
      summary: Twitch chat badges
      description: 'Every badge a chat message in this Twitch channel can carry, with its images: Twitch''s global badges, with the channel''s own subscriber and bits images in place of the global ones they replace. A chat client receives only `set/version` pairs with each message (the IRC `badges` tag), which this resolves. 404 when the login is not a Twitch channel. Cached one hour.'
      tags:
      - Streamers
      parameters:
      - in: path
        name: login
        required: true
        schema:
          type: string
          description: Twitch channel login, e.g. `license__`.
        description: Twitch channel login, e.g. `license__`.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TwitchChatBadgesResponse'
components:
  schemas:
    LiveStreamer:
      type: object
      properties:
        region:
          type: string
          enum:
          - eu
          - na
          - asia
        accountId:
          type: number
        nickname:
          type: string
        clanTag:
          type:
          - string
          - 'null'
        clanColor:
          type:
          - string
          - 'null'
        wn7:
          type:
          - number
          - 'null'
        wn8:
          type:
          - number
          - 'null'
        wnx:
          type:
          - number
          - 'null'
        pr:
          type:
          - number
          - 'null'
        wtr:
          type:
          - number
          - 'null'
        wn730d:
          type:
          - number
          - 'null'
        wn830d:
          type:
          - number
          - 'null'
        wnx30d:
          type:
          - number
          - 'null'
        twitchLogin:
          type: string
        twitchUserName:
          type: string
        title:
          type: string
        viewerCount:
          type: number
        startedAt:
          type: string
          description: Stream start, ISO 8601.
        language:
          type: string
          description: Stream language, ISO 639-1.
        thumbnailUrl:
          type: string
        accounts:
          type: array
          items:
            type: object
            properties:
              region:
                type: string
                enum:
                - eu
                - na
                - asia
              accountId:
                type: number
            required:
            - region
            - accountId
          description: Every WoT account linked to this channel. The fields above describe the one the card shows, which is the most active of them. Absent from a snapshot published before this field existed.
      required:
      - region
      - accountId
      - nickname
      - clanTag
      - clanColor
      - wn7
      - wn8
      - wnx
      - wn730d
      - wn830d
      - wnx30d
      - twitchLogin
      - twitchUserName
      - title
      - viewerCount
      - startedAt
      - language
      - thumbnailUrl
      description: A tracked player currently live on Twitch, with ratings.
    TwitchChatBadgesResponse:
      type: object
      properties:
        login:
          type: string
        badges:
          type: array
          items:
            $ref: '#/components/schemas/TwitchChatBadge'
      required:
      - login
      - badges
    TwitchChatBadge:
      type: object
      properties:
        set:
          type: string
          description: Badge set, e.g. `subscriber`.
        version:
          type: string
          description: Version within the set, e.g. `12`.
        title:
          type: string
        image1x:
          type: string
          description: 18x18 PNG.
        image2x:
          type: string
          description: 36x36 PNG.
        image4x:
          type: string
          description: 72x72 PNG.
        channel:
          type: boolean
          description: Whether the image is the channel's own rather than Twitch's global one.
      required:
      - set
      - version
      - title
      - image1x
      - image2x
      - image4x
      - channel
      description: 'A chat badge, keyed the way a chat message''s `badges` tag names it: `set/version`.'
    LiveStreamersResponse:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/LiveStreamer'
      required:
      - results