> ## Documentation Index > Fetch the complete documentation index at: https://docs.konbiniapi.com/llms.txt > Use this file to discover all available pages before exploring further. # Get user live stream > Returns the current live stream for a user, including stream URLs and viewer count. Returns 404 if the user is not currently live. ## OpenAPI ````yaml /openapi.json get /v1/tiktok/users/{username}/live openapi: 3.1.0 info: title: KonbiniAPI version: 1.0.0 description: >- Social media API that normalizes Instagram, TikTok, X, and Reddit data into a consistent ActivityStreams 2.0 format. Every authenticated response includes `X-Credits-Remaining` and `X-Credits-Used` headers. Each successful request costs 1 credit. Requests that fail with 400, 5xx, or upstream errors are refunded (X-Credits-Used: 0). contact: name: KonbiniAPI email: hello@konbiniapi.com url: https://konbiniapi.com servers: - url: https://api.konbiniapi.com description: Production security: - apiKey: [] tags: - name: Instagram description: Instagram data endpoints - name: TikTok description: TikTok data endpoints - name: X description: X data endpoints - name: Reddit description: Reddit data endpoints paths: /v1/tiktok/users/{username}/live: get: tags: - TikTok summary: Get user live stream description: >- Returns the current live stream for a user, including stream URLs and viewer count. Returns 404 if the user is not currently live. operationId: tiktokGetUserLive parameters: - schema: type: string description: TikTok username (with or without @ symbol) example: khaby.lame required: true description: TikTok username (with or without @ symbol) name: username in: path responses: '200': description: Returns the live stream details headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: data: type: object properties: '@context': type: array prefixItems: - type: string enum: - https://www.w3.org/ns/activitystreams# - type: string enum: - https://konbiniapi.com/ns/social# description: ActivityStreams JSON-LD context example: - https://www.w3.org/ns/activitystreams# - https://konbiniapi.com/ns/social# type: type: string description: ActivityStreams object type example: Video id: type: string format: uri description: Live stream permalink example: https://www.tiktok.com/@khaby.lame/live url: type: string format: uri description: Live stream URL example: https://www.tiktok.com/@khaby.lame/live entityId: type: string description: TikTok internal room ID example: '7600000000000000001' published: type: string format: date-time description: Publication date in ISO 8601 format example: '2026-02-27T18:36:42.000Z' isLive: type: boolean description: Whether stream is currently live example: true viewCount: type: integer description: Number of views example: 42600000 viewerCount: type: integer description: Current number of viewers example: 15000 content: type: string description: Caption or description example: >- When you realize there is a simpler way #learnfromkhaby attributedTo: allOf: - $ref: '#/components/schemas/TikTokEmbeddedUser' - description: Stream host image: type: array items: $ref: '#/components/schemas/TikTokImage' description: Stream cover images attachment: type: array items: $ref: '#/components/schemas/TikTokLiveStreamAttachment' description: Stream media sources required: - '@context' - type - id - url - entityId - isLive - attributedTo required: - data '400': description: Bad Request — Invalid parameters headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - validation_error description: Machine-readable error code message: type: string example: Validation error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '401': description: Unauthorized — Missing or invalid API key content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - missing_api_key - invalid_api_key description: Machine-readable error code message: type: string example: Invalid API key description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '402': description: Payment Required — Credits exhausted content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - credits_exhausted description: Machine-readable error code message: type: string example: >- Credits exhausted. Upgrade your plan at konbiniapi.com description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '403': description: Forbidden — API key disabled or expired content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - api_key_disabled - api_key_expired description: Machine-readable error code message: type: string example: API key is disabled description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '404': description: Not Found headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - not_found - route_not_found description: Machine-readable error code message: type: string example: Not found description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '413': description: Content Too Large — Request body exceeds 1 MB content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - validation_error description: Machine-readable error code message: type: string example: Request body too large description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '500': description: Internal Server Error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - internal_error description: Machine-readable error code message: type: string example: Internal error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '502': description: Bad Gateway — Upstream platform error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - platform_error description: Machine-readable error code message: type: string example: Platform error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '503': description: Service Unavailable headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - service_unavailable description: Machine-readable error code message: type: string example: Service unavailable description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '504': description: Gateway Timeout — Upstream platform timed out headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - platform_error description: Machine-readable error code message: type: string example: Platform error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data components: schemas: TikTokEmbeddedUser: type: object properties: type: type: string description: ActivityStreams object type example: Person id: type: string format: uri description: Profile URL example: https://www.tiktok.com/@khaby.lame url: type: string format: uri description: Profile URL example: https://www.tiktok.com/@khaby.lame entityId: type: string description: TikTok secUid example: >- MS4wLjABAAAAwAg0rSzO65WQfz4RzQgGv2Xdv108BgPXhRrrmNVIHQZ9PO8-flwwRtEppYTS0OjA name: type: string description: Display name example: Khabane Lame preferredUsername: type: string description: Username or handle example: khaby.lame summary: type: string description: Bio text example: Just a guy who reacts attachment: type: array items: $ref: '#/components/schemas/TikTokLink' description: External links in bio published: type: string format: date-time description: Account creation date in ISO 8601 format example: '2020-03-15T00:00:00.000Z' isPrivate: type: boolean description: Whether account is private example: false isVerified: type: boolean description: Whether account is verified example: true isLive: type: boolean description: Whether user is currently live streaming example: false hasLikes: type: boolean description: Whether user's liked videos are public example: true hasPlaylists: type: boolean description: Whether user has playlists example: true followerCount: type: integer description: Number of followers example: 160300000 followingCount: type: integer description: Number of accounts followed example: 85 language: type: string description: User language preference (BCP47 code) example: en likeCount: type: integer description: Total likes received across all content example: 2600000000 likedCount: type: integer description: Number of videos the user has liked example: 5300 mediaCount: type: integer description: Number of posts example: 1309 icon: allOf: - $ref: '#/components/schemas/TikTokImage' - description: Author avatar image: type: array items: $ref: '#/components/schemas/TikTokImage' description: Profile pictures in multiple sizes required: - type - id - url - isPrivate - isVerified description: Compact user profile for embedded contexts TikTokImage: type: object properties: type: type: string description: ActivityStreams object type example: Image url: type: string format: uri description: Image URL example: https://p16-sign.tiktokcdn-us.com/tos-maliva-avt-0068/avatar.jpeg width: type: integer description: Width in pixels example: 576 height: type: integer description: Height in pixels example: 1024 required: - type - url description: Image resource with optional dimensions TikTokLiveStreamAttachment: type: object properties: type: type: string description: ActivityStreams object type example: Video url: type: array items: type: string format: uri description: Media download URLs example: - https://webcast.tiktok.com/live/pull/l4/stream.flv mediaType: type: string description: MIME type example: video/x-flv width: type: integer description: Width in pixels example: 576 height: type: integer description: Height in pixels example: 1024 name: type: string description: Stream quality label example: flv codec: type: string description: Video codec example: h264 bitrate: type: integer description: Bitrate in bits per second example: 2500000 required: - type - url - mediaType - name description: Live stream media source TikTokLink: type: object properties: type: type: string description: ActivityStreams object type example: Link href: type: string format: uri description: Link URL example: https://linktr.ee/khaby.lame rel: type: string description: Link relation hint example: preferred required: - type - href description: External link securitySchemes: apiKey: type: http scheme: bearer description: |- Send your API key in the Authorization header as a Bearer token. Example: `Authorization: Bearer ` ````