> **For coding agents and LLMs:** This is one page from the Social Fetch docs (markdown export). For curated orientation and workflow guidance, start with [`/llms.txt`](https://www.socialfetch.dev/llms.txt); for the full endpoint list with links to pages like this one, use [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt); use [`/llms.json`](https://www.socialfetch.dev/llms.json) when you need structured JSON for tool registration. ## This page - **On-site (HTML):** [https://www.socialfetch.dev/docs/api/v1/tiktok/ad-library/ads/get](https://www.socialfetch.dev/docs/api/v1/tiktok/ad-library/ads/get) - **Markdown (.mdx) URL:** [https://www.socialfetch.dev/docs/api/v1/tiktok/ad-library/ads/get.mdx](https://www.socialfetch.dev/docs/api/v1/tiktok/ad-library/ads/get.mdx) ## API base URL and authentication - **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev` - **Authentication:** send `x-api-key: sfk_...` on `/v1/**` routes unless the operation is explicitly anonymous (check OpenAPI `security`, the [API reference hub](https://www.socialfetch.dev/docs/api.mdx), [`/llms.txt`](https://www.socialfetch.dev/llms.txt), or [`/llms.json`](https://www.socialfetch.dev/llms.json) for each route). - **OpenAPI JSON:** [https://www.socialfetch.dev/openapi.json](https://www.socialfetch.dev/openapi.json) ## Recommended docs entrypoints (this site) - [Documentation overview](https://www.socialfetch.dev/docs.mdx) — top-level orientation (markdown). - [Quickstart](https://www.socialfetch.dev/docs/quickstart.mdx) — authenticate with `x-api-key`, validate auth with `whoami`, and understand the JSON envelope. - [SDK](https://www.socialfetch.dev/docs/sdk.mdx) — official TypeScript SDK guide, including `SocialFetchClient`, `Result`, and `unwrap()`. - [SDK reference](https://www.socialfetch.dev/docs/sdk-reference.mdx) — exhaustive SDK method inventory and route mapping for agents, tooling, and power users. - [Choose the right endpoint](https://www.socialfetch.dev/docs/choose-endpoint.mdx) — task-oriented route selection for smoke tests, profiles, list endpoints, and single-item lookups. - [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — fast comparison of identifiers, pagination, outcomes, media download, and SDK coverage. - [Integrations](https://www.socialfetch.dev/docs/integrations.mdx) — MCP for AI clients, n8n verified node, Apify Store Actors, SDK, and REST API connection paths. - [MCP integration](https://www.socialfetch.dev/docs/integrations/mcp.mdx) — hosted `/mcp` server, OAuth, Cursor/VS Code/Claude install snippets, 87 endpoint tools, plus docs_search/docs_read for implementation help. - [n8n integration](https://www.socialfetch.dev/docs/integrations/n8n.mdx) — install `n8n-nodes-socialfetch`, credentials, and workflow examples. - [Apify integration](https://www.socialfetch.dev/docs/integrations/apify.mdx) — Store Actors under @social-fetch, PPE billing, dataset export, and quick start. - [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt) — every documented operation with a direct link to that route's agent-readable markdown page (prefer this over parsing OpenAPI). - [`/llms.json`](https://www.socialfetch.dev/llms.json) — structured machine-readable operation inventory with parameter names, pagination, outcomes, credits, and SDK mapping. - [API reference hub](https://www.socialfetch.dev/docs/api.mdx) — human-friendly index of operations with links into generated pages. - [Errors](https://www.socialfetch.dev/docs/errors.mdx) — shared error envelope and HTTP status guidance. - [Credits](https://www.socialfetch.dev/docs/credits.mdx) — metering, `402`, and planning batch jobs. - Outcome semantics such as `found`, `not_found`, and `private` are documented in [Errors](https://www.socialfetch.dev/docs/errors.mdx) and on operation pages when present in the OpenAPI contract. ## Markdown docs convention - Every docs page has a markdown twin: append **`.mdx`** to the docs pathname (for example `/docs/quickstart` → `/docs/quickstart.mdx`). - Agents that send `Accept: text/markdown` on `/docs/**` HTML URLs may receive markdown directly (same URL, `Vary: Accept`). --- # Get TikTok Ad Library ad (https://www.socialfetch.dev/docs/api/v1/tiktok/ad-library/ads/get) ## Summary Get a single TikTok Ad Library or Top Ads creative by ad id or public ad URL. **Tags:** `TikTok` ## HTTP - **Method:** GET - **Path:** `/v1/tiktok/ad-library/ads` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** `client.tiktok.getAdLibraryAd({ adId?, url? })` - **Accepted identifiers:** `url` (query) - **Pagination:** none - **Business outcome field:** `data.lookupStatus` with values `found`, `not_found` ## Credits - **Base:** 1 credit per successful lookup. - **Maximum on success (200):** 1 credit. - **Normalization failure (502):** 1 credit charged. - **Authoritative field:** `meta.creditsCharged`. ## Authentication - **`x-api-key`**: API key (`sfk_...`) ## Parameters ### `adId` (query) - **Required:** no - **Constraints:** type `string`; minLength: 1; maxLength: 4096 - **Description:** TikTok Ad Library or Top Ads ad id. ### `url` (query) - **Required:** no - **Constraints:** type `string`; minLength: 1; maxLength: 4096 - **Description:** Public TikTok Ad Library or Top Ads detail URL for the ad. ## Responses (status codes) - **200**: TikTok Ad Library ad. - **400**: Invalid query parameters - **401**: Missing or invalid API key - **402**: Insufficient credits - **500**: Unexpected or billing error - **502**: Lookup could not be completed from the response (unexpected or invalid data). - **503**: Service temporarily unavailable; safe to retry with backoff. ## Response body (200) TikTok Ad Library ad. ### Field outline - **data** (required) — type `object`. Endpoint-specific response payload. - **lookupStatus** (required) — type `string`; enum: found, not_found. Whether the ad was found. - **ad** (required) — type `object`; nullable. Ad details when found; otherwise null. - **id** (required) — type `string`; minLength: 1. Stable identifier for the ad. - **title** (required) — type `string`; nullable. Ad title or caption when available. - **brandName** (required) — type `string`; nullable. Brand or advertiser name when available. - **cost** (required) — type `number`; nullable. Relative cost signal when available. - **ctr** (required) — type `number`; nullable. Click-through rate when available. - **likeCount** (required) — type `integer`; minimum: 0; nullable. Like count when available. - **industryKey** (required) — type `string`; nullable. Industry key reported for the ad when available. - **objective** (required) — type `string`; nullable. Campaign objective key when available. - **video** (required) — type `object`; nullable. Video creative when available. - **id** (required) — type `string`; nullable. Video id when available. - **durationSeconds** (required) — type `number`; nullable. Video duration in seconds when available. - **coverUrl** (required) — type `string`; nullable. Cover image URL when available. - **width** (required) — type `integer`; minimum: 0; nullable. Video width in pixels when available. - **height** (required) — type `integer`; minimum: 0; nullable. Video height in pixels when available. - **urls** (required) — type `object`; nullable. Playback URLs by resolution when available. - **p360** (required) — type `string`; nullable. 360p video URL when available. - **p480** (required) — type `string`; nullable. 480p video URL when available. - **p540** (required) — type `string`; nullable. 540p video URL when available. - **p720** (required) — type `string`; nullable. 720p video URL when available. - **p1080** (required) — type `string`; nullable. 1080p video URL when available. - **commentCount** (required) — type `integer`; minimum: 0; nullable. Comment count when available. - **shareCount** (required) — type `integer`; minimum: 0; nullable. Share count when available. - **countries** (required) — type `array`. Countries associated with the ad when available. - _items:_ - type `string`; minLength: 1 - **landingPageUrl** (required) — type `string`; nullable. Landing page URL when available. - **keywords** (required) — type `array`; nullable. Keywords associated with the ad when available. - _items:_ - type `string`; minLength: 1 - **objectives** (required) — type `array`. Campaign objectives reported for the ad. - _items:_ - **label** (required) — type `string`; nullable. Objective label when available. - **value** (required) — type `number`; nullable. Objective value when available. - **patterns** (required) — type `array`. Creative pattern labels when available. - _items:_ - type `string`; minLength: 1 - **source** (required) — type `string`; nullable. Reported ad source when available. - **hasVoiceOver** (required) — type `boolean`; nullable. Whether the ad includes a voice-over when known. - **detailUrl** (required) — type `string`; nullable. Public TikTok ad detail URL when available. - **interactiveAnalysis** (required) — type `object`; nullable. Second-by-second interactive analysis when available. - **ctr** (required) — type `object`; nullable. Click-through retention analysis when available. - **metric** (required) — type `string`; nullable. Metric name when available. - **analysis** (required) — type `array`. Second-by-second metric samples. - _items:_ - **duration** (required) — type `integer`; minimum: 0; nullable. Analysis duration in seconds when available. - **highlight** (required) — type `array`. Highlighted second offsets for this metric. - _items:_ - type `integer`; minimum: 0 - **percentile** (required) — type `number`; nullable. Percentile ranking for this metric when available. - **cvr** (required) — type `object`; nullable. Conversion retention analysis when available. - **metric** (required) — type `string`; nullable. Metric name when available. - **analysis** (required) — type `array`. Second-by-second metric samples. - _items:_ - **duration** (required) — type `integer`; minimum: 0; nullable. Analysis duration in seconds when available. - **highlight** (required) — type `array`. Highlighted second offsets for this metric. - _items:_ - type `integer`; minimum: 0 - **percentile** (required) — type `number`; nullable. Percentile ranking for this metric when available. - **clicks** (required) — type `object`; nullable. Click count analysis when available. - **metric** (required) — type `string`; nullable. Metric name when available. - **analysis** (required) — type `array`. Second-by-second metric samples. - _items:_ - **duration** (required) — type `integer`; minimum: 0; nullable. Analysis duration in seconds when available. - **highlight** (required) — type `array`. Highlighted second offsets for this metric. - _items:_ - type `integer`; minimum: 0 - **percentile** (required) — type `number`; nullable. Percentile ranking for this metric when available. - **conversion** (required) — type `object`; nullable. Conversion count analysis when available. - **metric** (required) — type `string`; nullable. Metric name when available. - **analysis** (required) — type `array`. Second-by-second metric samples. - _items:_ - **duration** (required) — type `integer`; minimum: 0; nullable. Analysis duration in seconds when available. - **highlight** (required) — type `array`. Highlighted second offsets for this metric. - _items:_ - type `integer`; minimum: 0 - **percentile** (required) — type `number`; nullable. Percentile ranking for this metric when available. - **remain** (required) — type `object`; nullable. Playback retention analysis when available. - **metric** (required) — type `string`; nullable. Metric name when available. - **analysis** (required) — type `array`. Second-by-second metric samples. - _items:_ - **duration** (required) — type `integer`; minimum: 0; nullable. Analysis duration in seconds when available. - **highlight** (required) — type `array`. Highlighted second offsets for this metric. - _items:_ - type `integer`; minimum: 0 - **percentile** (required) — type `number`; nullable. Percentile ranking for this metric when available. - **relatedAds** (required) — type `array`. Related ads recommended alongside this ad. - _items:_ - **id** (required) — type `string`; minLength: 1. Stable identifier for the ad. - **title** (required) — type `string`; nullable. Ad title or caption when available. - **brandName** (required) — type `string`; nullable. Brand or advertiser name when available. - **cost** (required) — type `number`; nullable. Relative cost signal when available. - **ctr** (required) — type `number`; nullable. Click-through rate when available. - **likeCount** (required) — type `integer`; minimum: 0; nullable. Like count when available. - **industryKey** (required) — type `string`; nullable. Industry key reported for the ad when available. - **objective** (required) — type `string`; nullable. Campaign objective key when available. - **video** (required) — type `object`; nullable. Video creative when available. - **id** (required) — type `string`; nullable. Video id when available. - **durationSeconds** (required) — type `number`; nullable. Video duration in seconds when available. - **coverUrl** (required) — type `string`; nullable. Cover image URL when available. - **width** (required) — type `integer`; minimum: 0; nullable. Video width in pixels when available. - **height** (required) — type `integer`; minimum: 0; nullable. Video height in pixels when available. - **urls** (required) — type `object`; nullable. Playback URLs by resolution when available. - **meta** (required) — type `object`. Metadata describing the request and billing outcome. - **requestId** (required) — type `string`; minLength: 1. Unique request identifier for tracing this API call. - **creditsCharged** (required) — type `integer`; minimum: 0. Credits charged for this request. - **version** (required) — type `string`; enum: v1. Public API version that served the response. ### Example JSON (found) ```json { "data": { "lookupStatus": "found", "ad": { "id": "7646829987799334920", "title": "I thought this was a gimmick until I tried it! A wrinkled shirt, one button, and a few minutes later... ready to wear.", "brandName": null, "cost": 1, "ctr": 0.5, "likeCount": 92, "industryKey": "label_22108000000", "objective": "campaign_objective_reach", "video": { "id": "v12044gd0000d8erq07og65h1cq991gg", "durationSeconds": 89.767, "coverUrl": "https://p16-common-sign.tiktokcdn.com/tos-maliva-p-0068c799-us/example~tplv-noop.image", "width": 720, "height": 1280, "urls": { "p360": null, "p480": null, "p540": "https://v16m-default.tiktokcdn.com/example-540p.mp4", "p720": "https://v16m-default.tiktokcdn.com/example-720p.mp4", "p1080": null } }, "commentCount": 1, "shareCount": 1, "countries": [ "TR" ], "landingPageUrl": "https://www.amazon.com/dp/B0DRTC8XBW", "keywords": null, "objectives": [ { "label": "campaign_objective_reach", "value": 5 } ], "patterns": [], "source": "Others", "hasVoiceOver": false, "detailUrl": "https://ads.tiktok.com/business/creativecenter/topads/7646829987799334920/pc/en", "interactiveAnalysis": { "ctr": { "metric": "retain_ctr", "analysis": [ { "second": 0, "value": 0.048 } ], "duration": 91, "highlight": [ 1 ], "percentile": 0.99 }, "cvr": { "metric": "retain_cvr", "analysis": [ { "second": 0, "value": 0 } ], "duration": 91, "highlight": [], "percentile": 0.99 }, "clicks": { "metric": "click_cnt", "analysis": [ { "second": 0, "value": 0.263 } ], "duration": 91, "highlight": [ 1 ], "percentile": 0.99 }, "conversion": { "metric": "convert_cnt", "analysis": [ { "second": 0, "value": 0 } ], "duration": 91, "highlight": [], "percentile": 0.99 }, "remain": { "metric": "play_retain_cnt", "analysis": [ { "second": 0, "value": 1 } ], "duration": 91, "highlight": [], "percentile": 0.99 } }, "relatedAds": [ { "id": "7644102379697602567", "title": "Related ad example title.", "brandName": null, "cost": 0, "ctr": 0.63, "likeCount": 127, "industryKey": "label_22108000000", "objective": "campaign_objective_reach", "video": { "id": "v1c044g50000d86qrfnog65v7nuvf30g", "durationSeconds": 13.213, "coverUrl": "https://p16-common-sign.tiktokcdn.com/example-related.image", "width": 576, "height": 1024, "urls": { "p360": null, "p480": null, "p540": null, "p720": "https://v16m-default.tiktokcdn.com/related-720p.mp4", "p1080": null } } } ] } }, "meta": { "requestId": "req_01tiktok_ad_library_ad_found", "creditsCharged": 1, "version": "v1" } } ``` ### Machine-readable error codes When an error JSON body is returned, it may include one of these `error.code` values (derived from the OpenAPI schemas for this operation; additional codes may exist at runtime): - `bad_request` ## Error handling & retries Interpret HTTP status codes using the descriptions below. Do not assume a JSON body unless the OpenAPI schema defines one for that status. - **400**: Invalid query parameters **Retry:** Fix the request; retrying the same invalid payload will not help. - **401**: Missing or invalid API key **Retry:** Fix the API key first; retrying without changes will not help. - **402**: Insufficient credits **Retry:** Do not retry without resolving billing/credits (retrying the same request will not help). - **500**: Unexpected or billing error - **502**: Lookup could not be completed from the response (unexpected or invalid data). **Retry:** May be transient; a few retries with backoff are reasonable. - **503**: Service temporarily unavailable; safe to retry with backoff. **Retry:** Usually safe to retry with exponential backoff and jitter. ### Suggested client defaults - Send the API key using the `x-api-key` header on every request. - On `503` (and sometimes `502`), retry with backoff; cap retries and surface a clear error to the user. - On `402`, surface an actionable billing message rather than blind retries. ## Examples ### TypeScript SDK ```typescript import { SocialFetchClient } from "@socialfetch/sdk"; const client = new SocialFetchClient({ apiKey: process.env.SOCIALFETCH_API_KEY!, }); const result = await client.tiktok.getAdLibraryAd({ adId: "7646829987799334920", }); if (!result.ok) { console.error(result.error); } else { console.log(result.value.data); } ``` ### Node.js ```javascript const response = await fetch( "https://api.socialfetch.dev/v1/tiktok/ad-library/ads?adId=7646829987799334920", { headers: { "x-api-key": "YOUR_API_KEY" } } ); const data = await response.json(); console.log(data); ``` ### cURL ```bash curl "https://api.socialfetch.dev/v1/tiktok/ad-library/ads?adId=7646829987799334920" \ -H "x-api-key: YOUR_API_KEY" ``` ### Python ```python import requests response = requests.get( "https://api.socialfetch.dev/v1/tiktok/ad-library/ads?adId=7646829987799334920", headers={"x-api-key": "YOUR_API_KEY"}, ) data = response.json() print(data) ```