Anuncios destacados de TikTok

Utiliza la API de Anuncios destacados de TikTok para integración de API para ecommerce. Consulta los parámetros, los campos de respuesta y los ejemplos de código.

Esta página documenta el contrato público de Ecommerce Data API. Conserva los nombres de campos, las rutas y los ejemplos técnicos para que puedas integrarla directamente.

Availability: Available

This endpoint is active in the v1 gateway, OpenAPI, and subscription catalog. A successful call consumes 1 billing unit.

POST /v1/tiktok/ads/top-ads

The request and response fields below match the current public contract.

Mapeo de la API

Item	Value
MCP Code	`tiktok_ads_top_ads`

Llamada rápida

First create an API key, then store it in a server-side environment variable:

export ECOMMERCE_DATA_API_KEY="your_api_key"

curl --request POST \
  --url https://ecommercedataapi.com/v1/tiktok/ads/top-ads \
  --header "Content-Type: application/json" \
  --header "X-API-Key: ${ECOMMERCE_DATA_API_KEY}" \
  --data '{
  "size": 20
}'

Integrate with an AI CLI

Copy for your AI CLI

Paste this task into Codex, Claude Code, Gemini CLI, or another coding agent.

Integrate the "TikTok Top Ads" endpoint from Ecommerce Data API into the current repository. Make the changes directly instead of only returning sample code.

API documentation: https://ecommercedataapi.com/en/docs/tiktok/ads/top-ads
Endpoint: POST https://ecommercedataapi.com/v1/tiktok/ads/top-ads
API key environment variable: ECOMMERCE_DATA_API_KEY

Example request:
{
"size": 20
}

Requirements:
1. Read the API documentation first, then inspect the repository's language, framework, HTTP client, directory structure, and environment-variable conventions.
2. Reuse the existing API client and error-handling patterns. If none exist, add the smallest reusable Ecommerce Data API client and an endpoint-specific wrapper.
3. Read the key from the server-side ECOMMERCE_DATA_API_KEY environment variable and send Content-Type: application/json plus the X-API-Key header. Never write a real key into source code, browser code, logs, test snapshots, or Git.
4. If the environment variable is missing, tell me to configure ECOMMERCE_DATA_API_KEY myself. Do not request, print, or invent the real key, and continue implementing code and tests that do not require a live request.
5. Implement request and response types from the documentation. Handle non-2xx responses, request_id, error.code, error.message, and 429 rate limits.
6. Add a minimal usage example or test that follows the repository's conventions. Run one minimal live request only when the key is already configured and external requests are allowed; otherwise use mocks or static validation.
7. Run the relevant formatter, type checker, and tests. Report changed files, usage, verification results, and any environment variable I still need to configure.

Need an API key?Create API key

Open this request in Postman

Download the preconfigured collection for this endpoint, then import it into Postman.

Download Postman config

Set the apiKey collection variable after import.Create API key

Node.js example

const response = await fetch(
  'https://ecommercedataapi.com/v1/tiktok/ads/top-ads',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'X-API-Key': process.env.ECOMMERCE_DATA_API_KEY,
    },
    body: JSON.stringify({
      size: 20,
    }),
  }
);

const result = await response.json();

if (!response.ok) {
  throw new Error(`${result.error?.code}: ${result.error?.message}`);
}

console.log(result.data);

Python example

import os
import requests

response = requests.post(
    "https://ecommercedataapi.com/v1/tiktok/ads/top-ads",
    headers={
        "Content-Type": "application/json",
        "X-API-Key": os.environ["ECOMMERCE_DATA_API_KEY"],
    },
    json={
        "size": 20,
    },
    timeout=30,
)

response.raise_for_status()
print(response.json()["data"])

Request body

Send the fields below directly in the JSON body without an extra wrapper. Undefined fields are rejected.

Field	Type	Required	Description	Example
`industryId`	String	No	Industry ID to narrow results. Omit for all industries.	10000000000
`size`	Integer	No	Items per page, 1–50.	20
`cursor`	String	No	Opaque cursor from the previous response's `next_cursor`. Omit for the first page.	eyJwYWdlIjoyfQ

Response structure

Field	Type	Description
`request_id`	String	Unique identifier for this request.
`data`	Object	Endpoint business data.

The fields below are inside data. For array endpoints they describe one array item; for paginated endpoints they describe one record in items[].

Response fields

Field	Type	Description	Example
`ads.ad_id`	String	Ad ID.	-
`ads.highlight`	String	Why the creative works, as summarized by the source.	-
`ads.likes`	Integer	Likes.	-
`ads.ctr`	Number	Click-through rate, 0–1.	-
`ads.cost_level`	Integer	Relative spend level, 1 (lowest) to 5.	-
`ads.video.duration_seconds`	Number	Video length in seconds.	-
`ads.video.cover_url`	String	Cover image URL.	-
`ads.video.video_url`	String	Video URL; links expire.	-
`total`	Integer	Total ads available.	-
`has_more`	Boolean	Whether another page is available.	true
`next_cursor`	String	Pass as `cursor` to get the next page; null on the last page.	-

Response example

{
  "request_id": "8fb43e59-4ff9-4dc8-a4b7-2ed164e45ab8",
  "data": {
    "ads": [
      {
        "ad_id": "7182310470102122497",
        "highlight": "Showcase a real-time comparison between products, while communicating your product's value and superiority. Leverage your product's unique features to encourage a purchase.",
        "likes": 33506,
        "ctr": 0.22,
        "cost_level": 2,
        "video": {
          "duration_seconds": 43.542,
          "cover_url": "https://p16-common-sign.tiktokcdn.com/v0201/d7f3c49928d44c02a8788be62fe9487b_1672261813~tplv-noop.image",
          "video_url": "https://v16m-default.tiktokcdn.com/a4c7a480bf08b3fa4dab7cfdce6b533f/6ae9a320/video/tos/alisg/tos-alisg-ve-0051c001-sg/oUDqTQQgQ5AeGDK5xfNUErbM56nUBBYIggTj6S/"
        }
      },
      {
        "ad_id": "7180025066401349634",
        "highlight": "Customers invest in brands based on how inclusive their video ads are. In this ad we see a diversity of customer groups giving their testimonies about the product.  ",
        "likes": 2458,
        "ctr": 0.13,
        "cost_level": 2,
        "video": {
          "duration_seconds": 28.334,
          "cover_url": "https://p16-common-sign.tiktokcdn.com/tos-alisg-p-0051c001-sg/oUyJbSIXHhgeGeDLJCS4ZtWHADPJt0AAqA2fd9~tplv-noop.image",
          "video_url": "https://v16m-default.tiktokcdn.com/97f1c1f4069c5f7a8fdc4b06876205a1/6ae9a311/video/tos/alisg/tos-alisg-ve-0051c001-sg/o0kAslxE2vGzYAoTwqo2kthlfBAmqQ0BHRYdDI/"
        }
      }
    ],
    "total": 5,
    "has_more": false,
    "next_cursor": null
  }
}

See Errors and rate limits for error payloads, request tracing, and rate-limit headers.

Esta página documenta el contrato público de Ecommerce Data API. Conserva los nombres de campos, las rutas y los ejemplos técnicos para que puedas integrarla directamente.

Availability: Available

This endpoint is active in the v1 gateway, OpenAPI, and subscription catalog. A successful call consumes 1 billing unit.

POST /v1/tiktok/ads/top-ads

The request and response fields below match the current public contract.

Mapeo de la API

Item	Value
MCP Code	`tiktok_ads_top_ads`

Llamada rápida

First create an API key, then store it in a server-side environment variable:

export ECOMMERCE_DATA_API_KEY="your_api_key"

curl --request POST \
  --url https://ecommercedataapi.com/v1/tiktok/ads/top-ads \
  --header "Content-Type: application/json" \
  --header "X-API-Key: ${ECOMMERCE_DATA_API_KEY}" \
  --data '{
  "size": 20
}'

Integrate with an AI CLI

Copy for your AI CLI

Paste this task into Codex, Claude Code, Gemini CLI, or another coding agent.

Integrate the "TikTok Top Ads" endpoint from Ecommerce Data API into the current repository. Make the changes directly instead of only returning sample code.

API documentation: https://ecommercedataapi.com/en/docs/tiktok/ads/top-ads
Endpoint: POST https://ecommercedataapi.com/v1/tiktok/ads/top-ads
API key environment variable: ECOMMERCE_DATA_API_KEY

Example request:
{
"size": 20
}

Need an API key?Create API key

Open this request in Postman

Download the preconfigured collection for this endpoint, then import it into Postman.

Download Postman config

Set the apiKey collection variable after import.Create API key

Node.js example

const response = await fetch(
  'https://ecommercedataapi.com/v1/tiktok/ads/top-ads',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'X-API-Key': process.env.ECOMMERCE_DATA_API_KEY,
    },
    body: JSON.stringify({
      size: 20,
    }),
  }
);

const result = await response.json();

if (!response.ok) {
  throw new Error(`${result.error?.code}: ${result.error?.message}`);
}

console.log(result.data);

Python example

import os
import requests

response = requests.post(
    "https://ecommercedataapi.com/v1/tiktok/ads/top-ads",
    headers={
        "Content-Type": "application/json",
        "X-API-Key": os.environ["ECOMMERCE_DATA_API_KEY"],
    },
    json={
        "size": 20,
    },
    timeout=30,
)

response.raise_for_status()
print(response.json()["data"])

Request body

Send the fields below directly in the JSON body without an extra wrapper. Undefined fields are rejected.

Field	Type	Required	Description	Example
`industryId`	String	No	Industry ID to narrow results. Omit for all industries.	10000000000
`size`	Integer	No	Items per page, 1–50.	20
`cursor`	String	No	Opaque cursor from the previous response's `next_cursor`. Omit for the first page.	eyJwYWdlIjoyfQ

Response structure

Field	Type	Description
`request_id`	String	Unique identifier for this request.
`data`	Object	Endpoint business data.

The fields below are inside data. For array endpoints they describe one array item; for paginated endpoints they describe one record in items[].

Response fields

Field	Type	Description	Example
`ads.ad_id`	String	Ad ID.	-
`ads.highlight`	String	Why the creative works, as summarized by the source.	-
`ads.likes`	Integer	Likes.	-
`ads.ctr`	Number	Click-through rate, 0–1.	-
`ads.cost_level`	Integer	Relative spend level, 1 (lowest) to 5.	-
`ads.video.duration_seconds`	Number	Video length in seconds.	-
`ads.video.cover_url`	String	Cover image URL.	-
`ads.video.video_url`	String	Video URL; links expire.	-
`total`	Integer	Total ads available.	-
`has_more`	Boolean	Whether another page is available.	true
`next_cursor`	String	Pass as `cursor` to get the next page; null on the last page.	-

Response example

{
  "request_id": "8fb43e59-4ff9-4dc8-a4b7-2ed164e45ab8",
  "data": {
    "ads": [
      {
        "ad_id": "7182310470102122497",
        "highlight": "Showcase a real-time comparison between products, while communicating your product's value and superiority. Leverage your product's unique features to encourage a purchase.",
        "likes": 33506,
        "ctr": 0.22,
        "cost_level": 2,
        "video": {
          "duration_seconds": 43.542,
          "cover_url": "https://p16-common-sign.tiktokcdn.com/v0201/d7f3c49928d44c02a8788be62fe9487b_1672261813~tplv-noop.image",
          "video_url": "https://v16m-default.tiktokcdn.com/a4c7a480bf08b3fa4dab7cfdce6b533f/6ae9a320/video/tos/alisg/tos-alisg-ve-0051c001-sg/oUDqTQQgQ5AeGDK5xfNUErbM56nUBBYIggTj6S/"
        }
      },
      {
        "ad_id": "7180025066401349634",
        "highlight": "Customers invest in brands based on how inclusive their video ads are. In this ad we see a diversity of customer groups giving their testimonies about the product.  ",
        "likes": 2458,
        "ctr": 0.13,
        "cost_level": 2,
        "video": {
          "duration_seconds": 28.334,
          "cover_url": "https://p16-common-sign.tiktokcdn.com/tos-alisg-p-0051c001-sg/oUyJbSIXHhgeGeDLJCS4ZtWHADPJt0AAqA2fd9~tplv-noop.image",
          "video_url": "https://v16m-default.tiktokcdn.com/97f1c1f4069c5f7a8fdc4b06876205a1/6ae9a311/video/tos/alisg/tos-alisg-ve-0051c001-sg/o0kAslxE2vGzYAoTwqo2kthlfBAmqQ0BHRYdDI/"
        }
      }
    ],
    "total": 5,
    "has_more": false,
    "next_cursor": null
  }
}

See Errors and rate limits for error payloads, request tracing, and rate-limit headers.

Ejemplos de datos de la API

Mapeo de la API

Llamada rápida

Integrate with an AI CLI

Copy for your AI CLI

Open this request in Postman

Node.js example

Python example

Request body

Response structure

Response fields

Response example

En esta página

Anuncios destacados de TikTok

Ejemplos de datos de la API

Mapeo de la API

Llamada rápida

Integrate with an AI CLI

Copy for your AI CLI

Open this request in Postman

Node.js example

Python example

Request body

Response structure

Response fields

Response example

En esta página