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

# Get TikTok posts by hashtag (live)

> Fetch posts carrying a hashtag on demand. Fetches directly from the platform and returns one page with a cursor. Not available for trial access keys.



## OpenAPI

````yaml https://api.xpoz.ai/openapi.json get /api/data/tiktok/posts/hashtags/{hashtag}/live
openapi: 3.1.0
info:
  title: XPOZ API
  version: 1.0.0
  description: >-
    Social media data API for Twitter/X, Instagram, Reddit, and TikTok.


    **Data endpoints** (`/api/data/*`) are authenticated with an API access key
    and are metered against the account's credits. Most stored-data endpoints
    share the same query options: `fields` selects which attributes to return,
    `since`/`until` bound the date range, and `responseType` picks between a
    synchronous first page (`fast`), a full paged query run as a background
    operation (`paging`), and a CSV export (`csv`). `/live` endpoints fetch from
    the platform on demand and page with a cursor instead.


    **Account, billing, and crawl-settings endpoints** are used by the XPOZ
    dashboard and authenticate with the user's session.
servers:
  - url: https://api.xpoz.ai
    description: Production
security: []
tags:
  - name: Twitter (live)
    description: >-
      On-demand Twitter/X fetches straight from the platform, cursor-paginated.
      Not available for trial access keys.
  - name: Instagram (live)
    description: >-
      On-demand Instagram fetches straight from the platform, cursor-paginated.
      Not available for trial access keys.
  - name: Reddit (live)
    description: >-
      On-demand Reddit fetches straight from the platform, cursor-paginated. Not
      available for trial access keys.
  - name: TikTok (live)
    description: >-
      On-demand TikTok fetches straight from the platform, cursor-paginated. Not
      available for trial access keys.
  - name: Operations
    description: Polling for background operations started with `responseType=paging`.
  - name: Account
    description: Access keys, plan, and usage of the signed-in user.
  - name: Billing
    description: Stripe checkout, subscription changes, and add-on purchases.
  - name: Crawl Settings
    description: Tracked items collected on a schedule.
  - name: System Status
    description: Platform status page and notifications.
  - name: Platform
    description: Health, metrics, and this spec.
paths:
  /api/data/tiktok/posts/hashtags/{hashtag}/live:
    get:
      tags:
        - TikTok (live)
      summary: Get TikTok posts by hashtag (live)
      description: >-
        Fetch posts carrying a hashtag on demand. Fetches directly from the
        platform and returns one page with a cursor. Not available for trial
        access keys.
      operationId: getDataTiktokPostsHashtagsHashtagLive
      parameters:
        - $ref: '#/components/parameters/TiktokHashtag'
        - $ref: '#/components/parameters/TiktokPostFields'
        - $ref: '#/components/parameters/Cursor'
      responses:
        '200':
          description: One page of results.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CursorResponse'
        '400':
          description: Validation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimpleError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/TrialForbidden'
        default:
          $ref: '#/components/responses/DataRouteError'
      security:
        - AccessKey: []
components:
  parameters:
    TiktokHashtag:
      name: hashtag
      in: path
      required: true
      description: >-
        TikTok hashtag ID (numeric) or hashtag name without the leading `#`.
        Names must match a hashtag exactly.
      schema:
        type: string
    TiktokPostFields:
      name: fields
      in: query
      required: false
      description: >-
        TikTok post fields to return. Comma-separated. Allowed values: id,
        postType, isPrivate, videoThumbnail, description, descriptionLanguage,
        userId, username, nickname, collectCount, commentCount, likeCount,
        downloadCount, forwardCount, playCount, hashtags, duration, videoUrl,
        transcriptsJson, createdAt, createdAtTimestamp, createdAtDate.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          enum:
            - id
            - postType
            - isPrivate
            - videoThumbnail
            - description
            - descriptionLanguage
            - userId
            - username
            - nickname
            - collectCount
            - commentCount
            - likeCount
            - downloadCount
            - forwardCount
            - playCount
            - hashtags
            - duration
            - videoUrl
            - transcriptsJson
            - createdAt
            - createdAtTimestamp
            - createdAtDate
    Cursor:
      name: cursor
      in: query
      required: false
      description: Opaque cursor from `next_page_cursor` of the previous page.
      schema:
        type: string
  schemas:
    CursorResponse:
      type: object
      properties:
        results:
          type: array
          items:
            type: object
            additionalProperties: true
            description: Entity shaped by the requested `fields`.
        count:
          type: integer
        dataSource:
          $ref: '#/components/schemas/DataSource'
        has_more:
          type: boolean
        next_page_cursor:
          anyOf:
            - type: string
            - type: 'null'
      required:
        - results
        - count
        - dataSource
        - has_more
        - next_page_cursor
      description: >-
        Envelope for on-demand `/live` endpoints: one provider page plus a
        cursor.
    SimpleError:
      type: object
      properties:
        success:
          type: boolean
          const: false
        message:
          type: string
      required:
        - success
        - message
    DataSource:
      type: string
      enum:
        - database
        - api
        - hybrid
      description: Where the results came from.
    TrialForbidden:
      type: object
      properties:
        success:
          type: boolean
          const: false
        code:
          type: string
          enum:
            - on_demand_not_available_in_trial
        message:
          type: string
      required:
        - success
        - code
        - message
    DataRouteError:
      type: object
      properties:
        success:
          type: boolean
          const: false
        message:
          type: string
          description: Endpoint-specific label, e.g. `Failed to retrieve Twitter posts`.
        error:
          type: string
          description: Detail. `An unexpected error occurred` for unhandled failures.
      required:
        - success
        - message
        - error
  responses:
    Unauthorized:
      description: Missing or invalid credentials.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SimpleError'
    TrialForbidden:
      description: On-demand search is not available for trial access keys.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/TrialForbidden'
    DataRouteError:
      description: >-
        The request could not be fulfilled. Status is 400 for an empty or
        invalid search query, 402 when CSV export is blocked by plan limits, 500
        otherwise.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DataRouteError'
  securitySchemes:
    AccessKey:
      type: http
      scheme: bearer
      description: >-
        XPOZ API access key, created from the dashboard or `POST /api/tokens`.
        Send as `Authorization: Bearer <access key>`.

````

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