POST
https://api.nexscope.ai/social/tiktok/ad-library/adEjecutar esta API
Envía una solicitud JSON para ejecutar esta API y recibir los datos de respuesta documentados.
Endpoint
| Método | POST |
| Ruta | https://api.nexscope.ai/social/tiktok/ad-library/ad |
| Autenticación | Bearer API key |
| Content-Type | application/json |
Parámetros de la solicitud
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
ad_id | string | obligatorio | Centro creativo Top Ads material ID o URL, o un anuncio de la biblioteca pública de anuncios ID o de la biblioteca.tiktok.com detalle URL. Ejemplo: 1869335220395266 |
Social data contract
Use your Nexscope API key. No supplier credentials are required. Requests reject unknown fields, including pageSize. URLs require HTTPS and an exact supported platform host and resource path. Documented YouTube video URLs may use youtu.be; other short links are unsupported. Check the request schema for supported fields and defaults.
Each request fetches one page. Continue manually with the returned nextCursor, or nextPage for Instagram Reels (pages 1–11). Cursors are opaque, unchanged strings up to 65536 UTF-8 bytes. No automatic pagination, retry, media download or transcription is performed. Repeated requests may purchase data again.
Resource status is independent of HTTP and billing: AVAILABLE, PARTIAL, PRIVATE, RESTRICTED, NOT_FOUND, NO_TRANSCRIPT or UNKNOWN can accompany code 0. Unknown values remain null; arrays remain empty arrays. fetchedAt is the response observation time; sourceFetchedAt is null without source evidence.
usage.billingStatus is NOT_CHARGED, SETTLED or UNKNOWN; chargedCredits is null when unconfirmed. Unknown charges never mean free. Completed lookups have a minimum charge of 10 credits, including cached, no-caption and unavailable-resource results; check API usage records for the actual charge. Parameter errors and unpublished APIs use the standard error envelope; upstream failures use code 13007, rate limits 429 and timeouts 408. Always check code and msg.
Respuesta de ejemplo
Estructura de respuesta de la plataforma. code 0 indica éxito o aceptación; data contiene el resultado de negocio.
{
"code": 0,
"cost": "-1",
"data": {
"data": {
"ad_title": "I thought this was a gimmick until I tried it! A wrinkled shirt, one button, and a few minutes later... ready to wear. Tap the link in bio and see why everyone’s talking about Bellairon before it sells out. @Bellairon LLC ",
"brand_name": "",
"comment": 1,
"cost": 1,
"country_code": [
"TR"
],
"creative_center_url": "https://ads.tiktok.com/business/creativecenter/topads/7646829987799334920/pc/en",
"ctr": 0.5,
"detail_analysis": null,
"favorite": false,
"has_summary": false,
"highlight_text": "",
"id": "7646829987799334920",
"industry_key": "label_22108000000",
"interactive_time_analysis": {
"clicks": {
"analysis": [
{
"second": 0,
"value": 0.2631578947368421
}
],
"duration": 91,
"highlight": [
1
],
"metric": "click_cnt",
"percentile": 0.99
},
"conversion": {
"analysis": [
{
"second": 0,
"value": 0
}
],
"duration": 91,
"highlight": [],
"metric": "convert_cnt",
"percentile": 0.99
},
"ctr": {
"analysis": [
{
"second": 0,
"value": 0.048321828136158054
}
],
"duration": 91,
"highlight": [
1
],
"metric": "retain_ctr",
"percentile": 0.99
},
"cvr": {
"analysis": [
{
"second": 0,
"value": 0
}
],
"duration": 91,
"highlight": [],
"metric": "retain_cvr",
"percentile": 0.99
},
"remain": {
"analysis": [
{
"second": 0,
"value": 1
}
],
"duration": 91,
"highlight": [],
"metric": "play_retain_cnt",
"percentile": 0.99
}
},
"is_search": false,
"keyword_list": null,
"landing_page": "https://www.amazon.com/dp/B0DRTC8XBW?ref=cm_sw_r_cso_wa_apin_dp_71W8F02XC4M4QZRQ5RQN&ref_=cm_sw_r_cso_wa_apin_dp_71W8F02XC4M4QZRQ5RQN&social_share=cm_sw_r_cso_wa_apin_dp_71W8F02XC4M4QZRQ5RQN&oas=true&utm_source=tiktok&utm_medium=paid&utm_id=__CAMPAIGN_ID__&utm_campaign=__CAMPAIGN_NAME__",
"like": 92,
"objective_key": "campaign_objective_reach",
"objectives": [
{
"label": "campaign_objective_reach",
"value": 5
}
],
"pattern_label": [],
"recommended_for_you": [
{
"ad_title": "Adımlarınıza eğlence katmaya hazır mısınız? \"Hiç böyle çorap görmüş müydünüz?\" diyoruz ve iddiamızı ortaya koyuyoruz! Giyimkent Outlet İndirim Çadırı'nda çorap modasına yepyeni bir boyut getirdik. Sevdiğiniz popüler kültür ve kült anime karakterlerini, kolları hareket edebilen bu özel 3 boyutlu tasarım çoraplarla tarzınıza taşıyın. İster günlük kombinlerinize eğlenceli bir dokunuş yapın, ister arkadaşlarınıza tebessüm ettirecek harika bir hediye seçin. Videomuzdaki gibi ister halay çektirin, ister horon teptirin; seçim sizin! Bu benzersiz ve eğlenceli tasarım çoraplarda dev fırsat: 2 Adet Sadece 100 TL! Favori karakterleriniz tükenmeden sizleri de Esenler'deki Giyimkent Outlet indirim çadırımıza bekliyoruz. Adresimiz: Oruçreis mah. Giyimkent Caddesi No:5 Esenler/İstanbul M7 Metro Hattı Giyimkent durağı önü. Hafta içi 10:00 ile 19:00 Hafta Sonu 10:00 - 20:00 Saatleri Arasında açıktır. #alışverişfestivali #kampanya #outlet #giyimkent ",
"brand_name": "",
"cost": 0,
"ctr": 0.63,
"favorite": false,
"id": "7644102379697602567",
"industry_key": "label_22108000000",
"is_search": false,
"like": 127,
"objective_key": "campaign_objective_reach",
"video_info": {
"cover": "https://p16-common-sign.tiktokcdn.com/tos-alisg-p-0037/ogCtJD4GUCr8GavLIfI1jAQ9IDvNeGEAfjQgg9~tplv-noop.image?dr=18692&refresh_token=fc9b28a3&x-expires=1781231805&x-signature=zYq%2F3BQnXoM8CMFBFKDON6lhPBs%3D&t=9276707c&ps=14f1eb3e&shp=9e36835a&shcp=317596d8&idc=my&VideoID=v1c044g50000d86qrfnog65v7nuvf30g",
"duration": 13.213,
"height": 1024,
"vid": "v1c044g50000d86qrfnog65v7nuvf30g",
"video_url": {
"720p": "https://v16m-default.tiktokcdn.com/1342656e028b133716a1e892a89e214a/6a2b70bd/video/tos/alisg/tos-alisg-pve-0037c001/os3NtUfeIHH1ALjc3Q4IWADrx9BGCBG8IEgejj/?a=0&bti=NTU4QDM1NGA%3D&&bt=837&ft=cApXJCz7ThWHanz9LGZmo0P&mime_type=video_mp4&rc=ZDY4NTppZjg4ZWY6Nzc2NEBpajZ5cXk5cml0OzMzODczNEAwYi41YWMwNWMxYGEyM2IyYSMtY3I0MmRrbzNhLS1kMWBzcw%3D%3D&vvpl=1&l=20260612043632D3452D043274878B2384&btag=e000b0000"
},
"width": 576
}
}
],
"share": 1,
"source": "Others",
"source_key": 73,
"success": true,
"video_info": {
"cover": "https://p16-common-sign.tiktokcdn.com/tos-maliva-p-0068c799-us/oIbqBdvfEAiFpgvAOgrQHCF5R0mkDDLiEfvQDS~tplv-noop.image?dr=18692&refresh_token=2cdb79e2&x-expires=1781231880&x-signature=W%2BBTq1VGRRaNnIuMGUpWWSgmOoo%3D&t=9276707c&ps=14f1eb3e&shp=9e36835a&shcp=317596d8&idc=my&VideoID=v12044gd0000d8erq07og65h1cq991gg",
"duration": 89.767,
"height": 1280,
"vid": "v12044gd0000d8erq07og65h1cq991gg",
"video_url": {
"540p": "https://v16m-default.tiktokcdn.com/3e7ec770348dbc627fc02ea1e8417c25/6a2b7108/video/tos/maliva/tos-maliva-ve-0068c799-us/oIN2GPIRgHAUBHOeNfLk2HBSERoJeIALGC3jAE/?a=0&bti=NTU4QDM1NGA%3D&&bt=315&ft=cApXJCz7ThWHKnz9LGZmo0P&mime_type=video_mp4&rc=Omk6ZWQ7Nzc7OGY8PGVnOkBpajQ8Zms5cjN1OzMzZzczNEBgNDAzXl9hXjMxLzEvXjFiYSNkNm4uMmQ0bmJhLS1kMS9zcw%3D%3D&vvpl=1&l=20260612043631BE40574FD5FFAA863321&btag=e00090000",
"720p": "https://v16m-default.tiktokcdn.com/9f16ea869602069b9fdad27dc113cb48/6a2b7108/video/tos/maliva/tos-maliva-ve-0068c799-us/ooEipQa9HbhJ4ChzASIngUPhBAdXiABIvxU2E/?a=0&bti=NTU4QDM1NGA%3D&&bt=877&ft=cApXJCz7ThWHKnz9LGZmo0P&mime_type=video_mp4&rc=ZTg3OTQ0NTQzZGVpNWg6NkBpajQ8Zms5cjN1OzMzZzczNEBhNC0yMDViNi8xLV9hX2AuYSNkNm4uMmQ0bmJhLS1kMS9zcw%3D%3D&vvpl=1&l=20260612043631BE40574FD5FFAA863321&btag=e00090000"
},
"width": 720
},
"voice_over": false
},
"platform": "tiktok-ad-library",
"resourceStatus": "AVAILABLE",
"usage": {
"billingStatus": "UNKNOWN"
}
},
"msg": null,
"time": "2026-01-01 00:00:00",
"traceId": null,
"ts": "0"
}Campos de respuesta
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
code | integer | obligatorio | 0 means accepted or successful; nonzero is a platform error. |
cost | string | obligatorio | Elapsed milliseconds, never credits; -1 outside web requests. |
data | any | obligatorio | Valor de Data usado por esta operación de API. |
msg | string | null | obligatorio | Valor de Msg usado por esta operación de API. |
time | string | obligatorio | Server local time: yyyy-MM-dd HH:mm:ss. |
traceId | string | null | obligatorio | Valor de Trace id usado por esta operación de API. |
ts | string | obligatorio | Epoch milliseconds. |
Opción 1 de cualquier alternativa — requiere platform, resourceStatus, data, usage
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data | object | obligatorio | Valor de Data usado por esta operación de API. |
data.data | object | obligatorio | Valor de Data usado por esta operación de API. |
data.platform | string | obligatorio | Valor de Platform usado por esta operación de API. |
data.resourceStatus | string | obligatorio | Valor de Resource status usado por esta operación de API. |
data.usage | object | obligatorio | Valor de Usage usado por esta operación de API. |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data | null | obligatorio | Valor de Data usado por esta operación de API. |
Respuestas
| Código | Descripción |
|---|---|
| 200 | Respuesta HTTP predeterminada tanto para el éxito como para muchos errores de negocio. Solo el código JSON externo 0 indica éxito o aceptación asíncrona; consulta data para obtener el resultado. |
| 429 | Límite de admisión de ejecuciones; respeta Retry-After cuando esté presente. |
| 503 | La admisión de ejecuciones no está disponible temporalmente; respeta Retry-After cuando esté presente. |
| Opcional | X-Nexscope-Http-Status: semantic asigna estados HTTP a los errores de negocio gestionados por el controlador en las rutas de ejecución y tareas. Los fallos previos a la autenticación, como la ausencia de una clave API (code 11209), pueden seguir devolviendo HTTP 200 antes de esta asignación. Comprueba siempre el código JSON externo; las solicitudes malformadas y los fallos de infraestructura también pueden devolver respuestas HTTP distintas de 200. |
Fuente de datos, vigencia y limitaciones
La fuente, la vigencia, la cobertura, los límites de frecuencia y las notas de estimación no se especifican en esta definición de API salvo que aparezcan en la documentación de campos de solicitud o respuesta anterior. No supongas datos oficiales del mercado ni actualización en tiempo real cuando no estén documentados explícitamente.