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

# Get Live TikTok Video

> Fetch normalized details and current engagement metrics for a TikTok video URL. Signed media URLs are temporary and should be downloaded promptly.

**Pricing**: 0.5 credits per video scraped ($0.005)



## OpenAPI

````yaml https://app.stainless.com/api/spec/documented/influship-api/openapi.documented.yml get /v1/raw/tiktok/video
openapi: 3.1.0
info:
  title: Influship API
  version: 1.0.0
  description: >
    Public API for creator search, profile lookup, and campaign-fit analysis.


    ## Authentication


    Send your API key in the `X-API-Key` header on every authenticated request.


    ```bash

    curl -H "X-API-Key: your_api_key"
    https://api.influship.com/v1/creators/autocomplete?q=fitness

    ```


    ## Billing and Rate Limits


    The API uses credit-based billing and credit-based rate limits.


    - every endpoint has a credit cost

    - successful responses include `X-Credits-Charged` and `X-Credits-Features`

    - rate limits are enforced with per-minute and per-hour credit budgets

    - rate limit state is returned in the `RateLimit-*` headers


    ## Agentic Payments


    The security entries in this base SDK contract describe `X-API-Key`
    authentication. The hosted discovery document at
    `https://api.influship.com/openapi.json` augments currently enabled paid
    operations with `402` responses and `x-payment-info` metadata for x402 v2
    and MPP. Use that hosted document when building no-key payment clients
    because supported operations and payment rails are deployment-dependent.


    ## Pagination


    List endpoints use cursor pagination.


    - send `limit` to control page size

    - use `next_cursor` from the response to fetch the next page

    - stop when `has_more` is `false`


    Search has one special rule:


    - `POST /v1/search` creates a persisted search session

    - `GET /v1/search/{id}` paginates that session for free

    - free pagination is capped by the original search `limit`


    ## Errors


    Errors use a consistent shape:


    ```json

    {
      "error": {
        "code": "rate_limit_exceeded",
        "message": "Rate limit exceeded (per minute)"
      }
    }

    ```


    See each operation for exact request and response schemas.
  contact:
    name: Influship Support
    email: support@influship.com
  license:
    name: Proprietary
    url: https://influship.com/terms
servers:
  - url: https://api.influship.com
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Health
    description: API health and status endpoints
  - name: Creators
    description: >-
      Retrieve creator profiles and discover new creators through search,
      autocomplete, and lookalike matching. Creators are cross-platform entities
      that may have profiles on multiple social networks.
  - name: Profiles
    description: >-
      Access individual social media profiles with detailed metrics, growth
      data, and activity information. Profiles are platform-specific accounts
      linked to creators.
  - name: Creator Emails
    description: >-
      Look up known creator email addresses by creator ID or social username.
      Empty or unresolved results are not billable.
  - name: Posts
    description: >-
      Retrieve and analyze social media posts with engagement metrics, media
      content, and performance data.
  - name: Search
    description: >-
      AI-powered semantic search to find creators using natural language
      queries. Understands intent and context to match creators based on content
      themes, audience, and style.
  - name: Live Scraping
    description: >-
      Fetch fresh data directly from social platforms in real-time. Use when you
      need the most current information or data for profiles not yet in our
      database.
paths:
  /v1/raw/tiktok/video:
    get:
      tags:
        - Live Scraping
      summary: Get Live TikTok Video
      description: >-
        Fetch normalized details and current engagement metrics for a TikTok
        video URL. Signed media URLs are temporary and should be downloaded
        promptly.


        **Pricing**: 0.5 credits per video scraped ($0.005)
      operationId: getLiveTikTokVideo
      parameters:
        - schema:
            $ref: '#/components/schemas/TikTokVideoUrl'
            description: HTTPS TikTok video or share URL
            example: https://www.tiktok.com/@creator/video/7517114944362499342
          in: query
          name: url
          required: true
          description: HTTPS TikTok video or share URL
        - schema:
            description: Two-letter region code
            example: GB
            type: string
            minLength: 2
            maxLength: 2
            pattern: ^[a-zA-Z]{2}$
          in: query
          name: region
          description: Two-letter region code
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LiveTikTokVideoResponse'
        '400':
          description: Validation error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error400'
        '401':
          description: Authentication error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Permission error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not found error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '422':
          description: >-
            Unprocessable entity response. The request was well-formed but a
            value failed a semantic rule (e.g. an invalid social handle format).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
        '429':
          description: >-
            Rate limit exceeded response. Check Retry-After header for backoff
            timing. Also returned (without RateLimit-* headers) when an IP is
            temporarily blocked after repeated failed authentication attempts.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error429'
        '500':
          description: Internal server error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error500'
        '503':
          description: >-
            Service unavailable response for temporary upstream dependency
            failures, including payment facilitators and live-data provider
            throttling. Check Retry-After when present.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error503'
      x-codeSamples:
        - lang: JavaScript
          source: |-
            import Influship from 'influship';

            const client = new Influship({
              apiKey: process.env['INFLUSHIP_API_KEY'], // This is the default and can be omitted
            });

            const response = await client.raw.tiktok.getVideo({
              url: 'https://www.tiktok.com/@creator/video/7517114944362499342',
            });

            console.log(response.data);
        - lang: Python
          source: |-
            import os
            from influship import Influship

            client = Influship(
                api_key=os.environ.get("INFLUSHIP_API_KEY"),  # This is the default and can be omitted
            )
            response = client.raw.tiktok.get_video(
                url="https://www.tiktok.com/@creator/video/7517114944362499342",
            )
            print(response.data)
components:
  schemas:
    TikTokVideoUrl:
      $ref: '#/components/schemas/TikTokUrl'
      type: string
      format: uri
    LiveTikTokVideoResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/TikTokVideoResponse'
      required:
        - data
      additionalProperties: false
    Error400:
      $ref: '#/components/schemas/Error'
      description: Validation error response
      examples:
        - error:
            code: validation_error
            message: 'Invalid value for parameter ''limit'': must be between 1 and 100'
            param: limit
            request_id: 550e8400-e29b-41d4-a716-446655440000
    Error401:
      $ref: '#/components/schemas/Error'
      description: Authentication error response
      examples:
        - error:
            code: unauthorized
            message: API key missing or invalid
            request_id: 550e8400-e29b-41d4-a716-446655440000
    Error403:
      $ref: '#/components/schemas/Error'
      description: Permission error response
      examples:
        - error:
            code: forbidden
            message: Your plan does not include access to this endpoint
            request_id: 550e8400-e29b-41d4-a716-446655440000
    Error404:
      $ref: '#/components/schemas/Error'
      description: Not found error response
      examples:
        - error:
            code: not_found
            message: Creator with ID '123e4567-e89b-12d3-a456-426614174000' not found
            request_id: 550e8400-e29b-41d4-a716-446655440000
    Error422:
      $ref: '#/components/schemas/Error'
      description: >-
        Unprocessable entity response. The request was well-formed but a value
        failed a semantic rule (e.g. an invalid social handle format).
      examples:
        - error:
            code: validation_error
            message: Invalid Instagram username format
            param: username
            request_id: 550e8400-e29b-41d4-a716-446655440000
    Error429:
      $ref: '#/components/schemas/Error'
      description: >-
        Rate limit exceeded response. Check Retry-After header for backoff
        timing. Also returned (without RateLimit-* headers) when an IP is
        temporarily blocked after repeated failed authentication attempts.
      examples:
        - error:
            code: rate_limit_exceeded
            message: Rate limit exceeded (per minute)
            request_id: 550e8400-e29b-41d4-a716-446655440000
        - error:
            code: rate_limit_exceeded
            message: Rate limit exceeded (per hour)
            request_id: 550e8400-e29b-41d4-a716-446655440001
        - error:
            code: rate_limit_exceeded
            message: Too many failed authentication attempts. Please try again later.
            request_id: 550e8400-e29b-41d4-a716-446655440002
    Error500:
      $ref: '#/components/schemas/Error'
      description: Internal server error response
      examples:
        - error:
            code: internal_error
            message: An unexpected error occurred. Please try again later.
            request_id: 550e8400-e29b-41d4-a716-446655440000
    Error503:
      $ref: '#/components/schemas/Error'
      description: >-
        Service unavailable response for temporary upstream dependency failures,
        including payment facilitators and live-data provider throttling. Check
        Retry-After when present.
      examples:
        - error:
            code: service_unavailable
            message: >-
              Live Instagram data is temporarily unavailable. Please retry
              shortly.
            request_id: 550e8400-e29b-41d4-a716-446655440000
            details:
              retry_after_seconds: 60
              upstream_error: upstream_rate_limited
    TikTokUrl:
      type: string
      format: uri
    TikTokVideoResponse:
      type: object
      properties:
        video:
          $ref: '#/components/schemas/TikTokVideo'
        scraped_at:
          type: string
          format: date-time
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
      required:
        - video
        - scraped_at
      additionalProperties: false
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              $ref: '#/components/schemas/ErrorCode'
              description: Machine-readable error code
            message:
              type: string
              description: Human-readable error message
              example: Request validation failed
            param:
              description: Parameter that caused the error (if applicable)
              example: query
              type: string
            request_id:
              description: Request ID for debugging
              example: 550e8400-e29b-41d4-a716-446655440000
              type: string
            details:
              description: Structured error context (e.g., field-level validation issues)
              type: object
              propertyNames:
                type: string
              additionalProperties: {}
          required:
            - code
            - message
          additionalProperties: false
      required:
        - error
      additionalProperties: false
    TikTokVideo:
      type: object
      properties:
        video_id:
          type: string
          minLength: 1
        url:
          $ref: '#/components/schemas/TikTokVideoUrl'
        author:
          type: object
          properties:
            user_id:
              type: string
              minLength: 1
            username:
              type: string
              minLength: 1
            display_name:
              type: string
            avatar_url:
              type:
                - string
                - 'null'
              format: uri
            is_verified:
              type: boolean
          required:
            - user_id
            - username
            - display_name
            - avatar_url
            - is_verified
          additionalProperties: false
        description:
          type: string
        created_at:
          type:
            - string
            - 'null'
          format: date-time
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
        duration_seconds:
          type:
            - number
            - 'null'
          minimum: 0
        media_type:
          type: string
          enum:
            - video
            - slideshow
        thumbnail_url:
          type:
            - string
            - 'null'
          format: uri
        video_url:
          type:
            - string
            - 'null'
          format: uri
        has_watermark:
          type:
            - boolean
            - 'null'
        images:
          type: array
          items:
            type: string
            format: uri
        view_count:
          type: integer
          minimum: 0
          maximum: 9007199254740991
        like_count:
          type: integer
          minimum: 0
          maximum: 9007199254740991
        comment_count:
          type: integer
          minimum: 0
          maximum: 9007199254740991
        share_count:
          type: integer
          minimum: 0
          maximum: 9007199254740991
        save_count:
          type: integer
          minimum: 0
          maximum: 9007199254740991
        hashtags:
          type: array
          items:
            type: string
        music:
          type:
            - object
            - 'null'
          properties:
            music_id:
              type:
                - string
                - 'null'
            title:
              type:
                - string
                - 'null'
            author:
              type:
                - string
                - 'null'
            duration_seconds:
              type:
                - number
                - 'null'
              minimum: 0
          required:
            - music_id
            - title
            - author
            - duration_seconds
          additionalProperties: false
        is_pinned:
          type: boolean
      required:
        - video_id
        - url
        - author
        - description
        - created_at
        - duration_seconds
        - media_type
        - thumbnail_url
        - video_url
        - has_watermark
        - images
        - view_count
        - like_count
        - comment_count
        - share_count
        - save_count
        - hashtags
        - music
        - is_pinned
      additionalProperties: false
    ErrorCode:
      type: string
      enum:
        - validation_error
        - invalid_parameter
        - missing_parameter
        - unauthorized
        - forbidden
        - payment_required
        - not_found
        - rate_limit_exceeded
        - quota_exceeded
        - internal_error
        - service_unavailable
        - database_error
        - seed_not_found
        - invalid_seeds
        - seed_resolution_failed
        - lookalike_failed
        - get_profiles_failed
        - post_analysis_failed
        - match_failed
        - scraping_failed
        - transcript_unavailable
        - transcript_not_available
        - transcription_limit_exceeded
        - transcription_unavailable
      description: Machine-readable error code for programmatic handling
      example: validation_error
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key

````