> ## 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 Your Live Stream

> Your stream setup, credentials, minutes and moderators.

Read your live stream setup: the RTMPS server URL and stream key for OBS, whether you are live, your monthly live minutes and your chat moderators.

## Behavior

* Needs an API key with gallery access, like the gallery endpoints. Other keys get `403` with type `forbidden`. See [Authentication](https://docs.snipp.gg/authentication.md).
* Streaming needs Plus or Ultra. Free accounts get `403` with type `plan_required`.
* `live_stream` is `null` until you [set up streaming](https://docs.snipp.gg/api-reference/endpoint/live/create.md).
* `ingest_url` is `rtmps://live.snipp.gg:443/live/`. Paste it and `stream_key` into OBS (Settings, Stream, Custom). Keep `stream_key` secret: anyone with it can stream as you.
* `ingest_url` and `stream_key` are `null` if the stream service could not be reached; try again.
* You go live automatically when your encoder connects, unless Preview Before Going Live is turned on in your streaming settings on the website. Then the stream waits in preview, reported as not live, until you press Go Live on your stream page. `live`, `started_at` and `viewers` reflect the current broadcast; `viewers` refreshes about once a minute.
* `minutes` is your monthly live streaming budget in whole minutes: 100 on Plus, 300 on Ultra. Minutes count while you are live or in preview and reset together with [priority minutes](https://docs.snipp.gg/concepts/plans.md#priority-minutes). When they run out the stream ends.
* `moderators` lists the users who can remove messages, time people out and ban people in your chat.
* `chat_enabled` and `chat_slow_seconds` are your chat settings. Change them with [Update Live Stream](https://docs.snipp.gg/api-reference/endpoint/live/update.md).
* Team keys are not accepted and get `401`.

## Example

```bash theme={null}
curl "https://api.snipp.gg/live" \
  -H "api-key: YOUR_API_KEY"
```


## OpenAPI

````yaml api-reference/openapi.json GET /live
openapi: 3.0.0
info:
  title: Snipp.gg API
  description: Image and video hosting API. Upload, manage, and share media files.
  version: 3.0.0
servers:
  - url: https://api.snipp.gg
    description: Default. Load-balanced across regions. No upload cap.
  - url: https://eu-west-1.api.snipp.gg
    description: EU West regional endpoint. Pins uploads and storage to EU West.
  - url: https://us-west-1.api.snipp.gg
    description: US West regional endpoint. Pins uploads and storage to US West.
  - url: https://flux.snipp.gg
    description: Alternative host. Capped at 100 MB per upload.
security:
  - apiKeyAuth: []
paths:
  /live:
    get:
      summary: Get Your Live Stream
      description: Your stream setup, credentials, minutes and moderators.
      operationId: getLiveStream
      responses:
        '200':
          description: Success. `live_stream` is `null` until streaming is set up.
          content:
            application/json:
              schema:
                type: object
                properties:
                  live_stream:
                    allOf:
                      - $ref: '#/components/schemas/SelfLiveStream'
                    nullable: true
                required:
                  - live_stream
              example:
                live_stream:
                  ingest_url: rtmps://live.snipp.gg:443/live/
                  stream_key: a1b2c3d4e5f6
                  live: true
                  title: Ranked grind
                  started_at: '2026-11-03T08:00:00.000Z'
                  viewers: 17
                  watch_url: https://snipp.live/nitcord
                  minutes:
                    used: 42
                    limit: 300
                    used_percent: 14
                    resets_at: '2026-11-20T19:30:00.000Z'
                  moderators:
                    - id: '9876543210'
                      username: snipp
                      nickname: Snipp
                      avatar: https://cdn.snipp.gg/avatar.png
                      verified: true
                      plan: free
                      suspended: false
          headers:
            request-id:
              $ref: '#/components/headers/RequestId'
        '401':
          $ref: '#/components/responses/E401'
        '403':
          $ref: '#/components/responses/E403'
        '405':
          $ref: '#/components/responses/E405'
        '429':
          $ref: '#/components/responses/E429'
        '500':
          $ref: '#/components/responses/E500'
components:
  schemas:
    SelfLiveStream:
      allOf:
        - type: object
          properties:
            ingest_url:
              type: string
              nullable: true
              description: RTMPS server URL for OBS or any RTMP app.
            stream_key:
              type: string
              nullable: true
              description: Secret. Anyone with it can stream as you.
          required:
            - ingest_url
            - stream_key
        - $ref: '#/components/schemas/LiveStream'
        - type: object
          properties:
            minutes:
              $ref: '#/components/schemas/LiveMinutes'
            moderators:
              type: array
              items:
                $ref: '#/components/schemas/LiveModerator'
              maxItems: 10
          required:
            - minutes
            - moderators
      description: Your own live stream, including the credentials to go live.
    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
    LiveMinutes:
      type: object
      description: Your monthly live streaming budget, in whole minutes.
      properties:
        used:
          type: integer
        limit:
          type: integer
          description: 100 on Plus, 300 on Ultra, scaled by any platform multiplier.
        used_percent:
          type: integer
          minimum: 0
          maximum: 100
        resets_at:
          type: string
          format: date-time
          nullable: true
      required:
        - used
        - limit
        - used_percent
        - resets_at
    LiveModerator:
      allOf:
        - $ref: '#/components/schemas/UserRef'
        - type: object
          properties:
            suspended:
              type: boolean
          required:
            - suspended
      description: A chat moderator you picked.
    Error:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
      required:
        - error
      description: Every non-2xx response has this body.
    UserRef:
      type: object
      properties:
        id:
          type: string
          description: User ID (snowflake).
        username:
          type: string
          nullable: true
        nickname:
          type: string
          nullable: true
        avatar:
          type: string
          description: Avatar URL. Falls back to `https://cdn.snipp.gg/avatar.png`.
        verified:
          type: boolean
        plan:
          $ref: '#/components/schemas/Plan'
      required:
        - id
        - username
        - nickname
        - avatar
        - verified
        - plan
      description: A user embedded inside another resource.
    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: weekly quota in bytes.'
        used:
          type: integer
          description: '`quota_exceeded` only: bytes used in the current window.'
        resets_at:
          type: string
          format: date-time
          description: '`quota_exceeded` only: when the weekly 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
    Plan:
      type: string
      enum:
        - free
        - plus
        - ultra
    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:
    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'
    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'
    E429:
      description: Rate limited
      headers:
        request-id:
          $ref: '#/components/headers/RequestId'
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
      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:
    apiKeyAuth:
      type: apiKey
      in: header
      name: api-key
      description: Your API key from an app on snipp.gg/settings/apps

````

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