> ## Documentation Index
> Fetch the complete documentation index at: https://docs.snipp.gg/llms.txt
> Use this file to discover all available pages before exploring further.

# Get User Live Stream

> Whether a user is live, and what they are streaming.

Check whether a user is live and what they are streaming. Use `@me` for yourself.

## Behavior

* `live` is `true` while a broadcast is running. `started_at` and `viewers` are `null` otherwise; `viewers` refreshes about once a minute.
* `title` and `watch_url` are filled whenever the user has set up streaming, live or not. `watch_url` (`https://snipp.live/{username}`) is where people watch and chat.
* A user who never set up streaming returns `live: false` with every other field `null`.
* A suspended user gives `403` with type `suspended`, and a user who blocked you gives `403` with type `blocked`.

## Example

```bash theme={null}
curl "https://relay.snipp.gg/users/987654321098765432/live" \
  -H "relay-key: YOUR_RELAY_KEY"
```


## OpenAPI

````yaml relay-reference/openapi.json GET /users/{id}/live
openapi: 3.0.0
info:
  title: Snipp.gg Relay API
  description: >-
    First-party Snipp API for the full user experience: uploads, posts,
    discover, likes, comments, notifications, blocks and profile management.
  version: 3.0.0
servers:
  - url: https://relay.snipp.gg
    description: Default. Load-balanced across regions. No upload cap.
  - url: https://eu-west-1.relay.snipp.gg
    description: EU West regional endpoint. Pins uploads and storage to EU West.
  - url: https://us-west-1.relay.snipp.gg
    description: US West regional endpoint. Pins uploads and storage to US West.
  - url: https://pulsar.snipp.gg
    description: Alternative host. Capped at 100 MB per upload.
security:
  - relayKeyAuth: []
paths:
  /users/{id}/live:
    get:
      summary: Get User Live Stream
      description: Whether a user is live, and what they are streaming.
      operationId: getUserLiveStream
      parameters:
        - $ref: '#/components/parameters/UserId'
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  live_stream:
                    $ref: '#/components/schemas/LiveStream'
                required:
                  - live_stream
              example:
                live_stream:
                  live: true
                  title: Ranked grind
                  started_at: '2026-11-03T08:00:00.000Z'
                  viewers: 17
                  watch_url: https://snipp.live/nitcord
          headers:
            request-id:
              $ref: '#/components/headers/RequestId'
        '400':
          $ref: '#/components/responses/E400'
        '401':
          $ref: '#/components/responses/E401'
        '403':
          $ref: '#/components/responses/E403'
        '404':
          $ref: '#/components/responses/E404'
        '405':
          $ref: '#/components/responses/E405'
        '500':
          $ref: '#/components/responses/E500'
components:
  parameters:
    UserId:
      name: id
      in: path
      required: true
      description: User ID, or `@me` for your own account.
      schema:
        type: string
      example: '@me'
  schemas:
    LiveStream:
      type: object
      description: A user's live stream as anyone can see it.
      properties:
        live:
          type: boolean
        title:
          type: string
          nullable: true
          maxLength: 140
        started_at:
          type: string
          format: date-time
          nullable: true
          description: When the current broadcast started. `null` unless live.
        viewers:
          type: integer
          nullable: true
          description: >-
            Concurrent viewers, refreshed about once a minute. `null` unless
            live.
        chat_enabled:
          type: boolean
          description: >-
            `false` when the streamer turned the chat off. Nobody can read or
            send messages until it is back on.
        chat_slow_seconds:
          type: integer
          enum:
            - 0
            - 5
            - 10
            - 30
            - 60
          description: >-
            Slow mode: how many seconds each viewer waits between messages. `0`
            is off. The streamer, their moderators and staff are exempt.
        watch_url:
          type: string
          nullable: true
          description: >-
            `https://snipp.live/{username}`. `null` when the user has not set up
            streaming.
      required:
        - live
        - title
        - started_at
        - viewers
        - chat_enabled
        - chat_slow_seconds
        - watch_url
    Error:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
      required:
        - error
      description: Every non-2xx response has this body.
    ErrorDetail:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ErrorType'
        message:
          type: string
          description: Human-readable sentence. Do not match on it; use `type`.
        username:
          type: string
          description: >-
            `suspended` on `GET /users/{id}` only: the suspended user's
            username.
        quota:
          type: integer
          description: >-
            `quota_exceeded` only: the limit, in bytes for the weekly quota or
            minutes for priority minutes.
        used:
          type: integer
          description: >-
            `quota_exceeded` only: usage in the current window, in the same unit
            as `quota`.
        resets_at:
          type: string
          format: date-time
          description: '`quota_exceeded` only: when the window resets.'
          nullable: true
        failed:
          type: array
          items:
            $ref: '#/components/schemas/FailedFile'
          description: '`upload_failed` only: one entry per file.'
        expires_at:
          type: string
          format: date-time
          description: '`timed_out` only: when the timeout ends.'
        retry_at:
          type: string
          format: date-time
          description: '`slow_mode` only: when you can send your next message.'
        missing:
          type: array
          items:
            type: integer
          description: >-
            `Missing chunks.` on the last piece of a chunked upload only:
            zero-based indexes of the pieces the server does not have. Send
            them, then the last piece again.
      required:
        - type
        - message
    ErrorType:
      type: string
      enum:
        - invalid_request
        - unauthorized
        - forbidden
        - suspended
        - blocked
        - moderated
        - plan_required
        - timed_out
        - banned
        - chat_off
        - slow_mode
        - not_found
        - method_not_allowed
        - file_too_large
        - unsupported_type
        - quota_exceeded
        - rate_limited
        - upload_failed
        - internal
        - unavailable
      description: Machine-readable error category. See [Errors](/concepts/errors).
    FailedFile:
      type: object
      properties:
        index:
          type: integer
          description: Zero-based position of the file in the request.
        error:
          $ref: '#/components/schemas/ErrorDetail'
      required:
        - index
        - error
      description: >-
        A file that was not stored. `error` has the same shape as a top-level
        error.
  headers:
    RequestId:
      description: Unique ID for the request. Include it when contacting support.
      schema:
        type: string
        format: uuid
  responses:
    E400:
      description: Invalid request
      headers:
        request-id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    E401:
      description: Missing or invalid key
      headers:
        request-id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    E403:
      description: Not allowed
      headers:
        request-id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    E404:
      description: Not found
      headers:
        request-id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    E405:
      description: Method not allowed
      headers:
        request-id:
          $ref: '#/components/headers/RequestId'
        Allow:
          description: Methods this path accepts.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    E500:
      description: Internal error
      headers:
        request-id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    relayKeyAuth:
      type: apiKey
      in: header
      name: relay-key
      description: Your relay key from snipp.gg/settings/relay

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.