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

# Keyword Insights

> Retrieve market insights for a keyword on TikTok, including related products, creator activity, and consumer interest trends.

<div className="inline-flex items-center gap-2 px-4 py-2 bg-yellow-50 dark:bg-yellow-900/20 border border-yellow-200 dark:border-yellow-800 rounded-lg">
  <span className="text-base">🪙</span>
  <span className="text-sm font-medium text-yellow-900 dark:text-yellow-100"><span className="font-semibold">2 credits</span><span className="text-yellow-700 dark:text-yellow-300 ml-1">per request</span></span>
</div>

## Copy for AI

<div className="my-6 rounded-xl border border-gray-200 bg-gray-50 p-5 dark:border-gray-800 dark:bg-gray-900/40">
  <div className="min-w-0">
    <p className="text-base font-semibold text-gray-900 dark:text-gray-100">🤖 Why Code When AI Can Do It For You?</p>
    <p className="mt-1 text-sm text-gray-700 dark:text-gray-300">Stop writing code like it's 1970! Let AI do the heavy lifting - click the sparkles to copy a perfectly formatted prompt for ChatGPT, Claude, or your favorite AI assistant.</p>
  </div>

  <div className="mt-4">
    <button
      type="button"
      className="inline-flex items-center gap-2 rounded-md border border-emerald-300 bg-emerald-50 px-3 py-2 text-sm font-medium text-emerald-800 hover:bg-emerald-100 dark:border-emerald-700 dark:bg-emerald-900/30 dark:text-emerald-100 dark:hover:bg-emerald-900/50"
      onClick={() => navigator.clipboard.writeText(`I want to make an API call to https://api.keyapi.ai/v1/tiktok/insights/keyword.

Please help me write code to make this API call and handle the response appropriately. Include error handling and best practices.

Here are the details:

Endpoint: GET https://api.keyapi.ai/v1/tiktok/insights/keyword

Description: Retrieve market insights for a keyword on TikTok, including related products, creator activity, and consumer interest trends.

Required Headers:
--header 'Authorization: Bearer <YOUR_API_KEY>'

Parameters:
- search_keyword (Optional): Search keywords, value-taking rules: FALSE (string type) = do not perform the search; non-empty string = perform the search according to the keyword. Example: FALSE
- page (Optional): Pagination page number, used to specify the target page number of the query results. Example: 1
- limit (Optional): The number of data items per page in pagination, which is used to specify the maximum number of results returned by a single query. The value range is 1 to 20. If it exceeds the maximum value, it will be automatically handled as 20.. Example: 20
- period (Optional): Time range for querying data
Optional valid values: 7 (last 7 days), 30 (last 30 days), 120 (last 120 days). Example: 7
- region (Optional): Country/region code, the default value "nothing" means not selecting any region. Example: nothing
- industry (Optional): Industry ID, with the default value "nothing" representing no industry selected. You can choose from the Popular Trends - Industry Classification Mapping.
- objective (Optional): Delivery targets (optional)
The default value "nothing" means no delivery target is selected.
Traffic = 1
App installations = 2
Conversions = 3
Video views = 4
Reach = 5
Lead generation = 8
Product sales = 14
- keyword_type (Optional): Keyword type: "nothing" means not selecting any keyword type
Selling point = 1
Pain point = 2
Target user = 3
Call to action = 4
Others = 5
Product = 6

Example Response:
{
"code": 0,
"message": "success",
"data": {
"keyword_list": [
  {
    "comment": 770,
    "cost": 172000,
    "cpa": 0.03,
    "ctr": 9.16,
    "cvr": 100,
    "impression": 57000000,
    "keyword": "play now",
    "like": 84986,
    "play_six_rate": 29.47,
    "post": 39300,
    "post_change": 69.7,
    "share": 580,
    "video_list": [
      "7572396491294149896",
      "7584805700031810817",
      "7586921072524545298",
      "7587647314320215314",
      "7597467387859979537"
    ]
  }
],
"pagination": {
  "page": 1,
  "size": 1,
  "total": 500,
  "has_more": true
}
},
"requestId": "314d0c7a-22b6-434b-883a-040485d23331"
}`)}
    >
      <span>✨</span>
      <span>Copy for AI</span>
    </button>
  </div>
</div>


## OpenAPI

````yaml en/tiktok.openapi.json GET /v1/tiktok/insights/keyword
openapi: 3.0.1
info:
  title: Tiktok API english documentation
  description: >-
    The english reference documentation of the Tiktok API includes the
    interface's purpose, parameter description, response status, and sample
    structure.
  version: 1.0.0
servers:
  - url: https://api.keyapi.ai
    description: Production
security: []
tags:
  - name: TikTok Influencer
  - name: TikTok Shop
  - name: TikTok Content
  - name: TikTok Intelligence
paths:
  /v1/tiktok/insights/keyword:
    get:
      tags:
        - TikTok Intelligence
      summary: Keyword Insights
      description: >-
        Retrieve market insights for a keyword on TikTok, including related
        products, creator activity, and consumer interest trends.
      operationId: get_api_v3_realtime_insights_keyword
      parameters:
        - name: search_keyword
          in: query
          description: >-
            Search keywords, value-taking rules: FALSE (string type) = do not
            perform the search; non-empty string = perform the search according
            to the keyword
          required: false
          schema:
            type: string
            example: 'FALSE'
            default: 'FALSE'
          example: 'FALSE'
        - name: page
          in: query
          description: >-
            Pagination page number, used to specify the target page number of
            the query results
          required: false
          schema:
            type: string
            example: '1'
            default: '1'
          example: '1'
        - name: limit
          in: query
          description: >-
            The number of data items per page in pagination, which is used to
            specify the maximum number of results returned by a single query.
            The value range is 1 to 20. If it exceeds the maximum value, it will
            be automatically handled as 20.
          required: false
          schema:
            type: string
            example: '20'
            default: '20'
          example: '20'
        - name: period
          in: query
          description: >-
            Time range for querying data

            Optional valid values: 7 (last 7 days), 30 (last 30 days), 120 (last
            120 days)
          required: false
          schema:
            type: string
            example: '7'
            default: '7'
          example: '7'
        - name: region
          in: query
          description: >-
            Country/region code, the default value "nothing" means not selecting
            any region
          required: false
          schema:
            type: string
            example: nothing
            default: nothing
          example: nothing
        - name: industry
          in: query
          description: >-
            Industry ID, with the default value "nothing" representing no
            industry selected. You can choose from the Popular Trends - Industry
            Classification Mapping.
          required: false
          schema:
            type: string
        - name: objective
          in: query
          description: |-
            Delivery targets (optional)
            The default value "nothing" means no delivery target is selected.
            Traffic = 1
            App installations = 2
            Conversions = 3
            Video views = 4
            Reach = 5
            Lead generation = 8
            Product sales = 14
          required: false
          schema:
            type: string
        - name: keyword_type
          in: query
          description: |-
            Keyword type: "nothing" means not selecting any keyword type
            Selling point = 1
            Pain point = 2
            Target user = 3
            Call to action = 4
            Others = 5
            Product = 6
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties: {}
                example:
                  code: 0
                  message: success
                  data:
                    keyword_list:
                      - comment: 770
                        cost: 172000
                        cpa: 0.03
                        ctr: 9.16
                        cvr: 100
                        impression: 57000000
                        keyword: play now
                        like: 84986
                        play_six_rate: 29.47
                        post: 39300
                        post_change: 69.7
                        share: 580
                        video_list:
                          - '7572396491294149896'
                          - '7584805700031810817'
                          - '7586921072524545298'
                          - '7587647314320215314'
                          - '7597467387859979537'
                    pagination:
                      page: 1
                      size: 1
                      total: 500
                      has_more: true
                  requestId: 314d0c7a-22b6-434b-883a-040485d23331
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 400
                  data: null
                  message: 'Missing required parameter: handle'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 401
                  data: null
                  message: apiKey is null
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 402
                  data: null
                  message: apiKey quota is not enough
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 429
                  data: null
                  message: qps limit exceeded
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 500
                  data: null
                  message: Internal server error
      deprecated: false
      security:
        - JWT Bearer: []
      x-codeSamples:
        - lang: curl
          label: cURL
          source: |-
            curl --request GET \
              --url 'https://api.keyapi.ai/v1/tiktok/insights/keyword?search_keyword=FALSE&page=1&limit=20&period=7&region=nothing' \
              --header 'Authorization: Bearer <YOUR_API_KEY>'
        - lang: python
          label: Python
          source: |-
            import requests

            response = requests.get(
                'https://api.keyapi.ai/v1/tiktok/insights/keyword',
                params={"search_keyword": "FALSE", "page": "1", "limit": "20", "period": "7", "region": "nothing"},
                headers={'Authorization': 'Bearer <YOUR_API_KEY>'}
            )
            print(response.json())
        - lang: javascript
          label: JavaScript
          source: >-
            const params = new URLSearchParams({"search_keyword": "FALSE",
            "page": "1", "limit": "20", "period": "7", "region": "nothing"});


            const response = await
            fetch(`https://api.keyapi.ai/v1/tiktok/insights/keyword?${params}`,
            {
              method: 'GET',
              headers: { 'Authorization': 'Bearer <YOUR_API_KEY>' }
            });

            const data = await response.json();

            console.log(data);
components:
  securitySchemes:
    JWT Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: |-
        API key for authentication. Format: `sk_live_xxxxxxxxxxxxx`
        Get your API key from the [Dashboard](http://keyapi.ai/app/dashboard).

````