TikTok Ad Transparency Search
Search TikTok's EU Commercial Content Library (ad transparency) by keyword, optionally narrowed to one advertiser id, region and sort order.
- Price per call
- 3 credits
- per successful call
- Price ceiling
- 13 credits
- if a call is retried elsewhere
- Failed calls
- Free
- retried automatically
- Billed
- Per call
- only on success
Endpoint
api.primaryapi.com/ v1/ run/ tiktok. ad_transparency_searchAuth: API key with run or full access, or a dashboard session
Send the input below as a JSON body. The call is routed to a healthy upstream; if an attempt fails, it is retried automatically inside the same request and you pay only for the answer you get. To check an input and see the exact price without running anything, call POST /v1/quote/tiktok.ad_transparency_search with the same body (free).
Example request
curl -sS -X POST "https://api.primaryapi.com/v1/run/tiktok.ad_transparency_search" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"query":"gymshark"}'const res = await fetch('https://api.primaryapi.com/v1/run/tiktok.ad_transparency_search', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.PRIMARYAPI_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
query: 'gymshark',
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.code}: ${body.error}`);
// found:false is a successful answer ("does not exist"), not an error
console.log(body.output.found ? body.output.data : body.output.reason, body.credits);import os
import requests
res = requests.post(
"https://api.primaryapi.com/v1/run/tiktok.ad_transparency_search",
headers={"Authorization": f"Bearer {os.environ['PRIMARYAPI_API_KEY']}"},
json={
"query": "gymshark",
},
timeout=60,
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['code']}: {body['error']}")
# found=False is a successful answer ("does not exist"), not an error
print(body["output"]["data"] if body["output"]["found"] else body["output"]["reason"], body["credits"]){
"name": "run_api",
"arguments": {
"sku": "tiktok.ad_transparency_search",
"input": {
"query": "gymshark"
}
}
}Price this exact input first (free)
curl -sS -X POST "https://api.primaryapi.com/v1/quote/tiktok.ad_transparency_search" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"query":"gymshark"}'Returns credits (what the call is expected to cost) and maxCredits (the most it can cost, which is set aside while it runs). Invalid input fails here the same way it would on run.
Input
JSON body fields. Unknown fields are rejected with 400 invalid_input (never silently ignored). You may add the routing controls preferLatencyUnderMs and maxCredits to the same object.
querystringrequired- Keyword to search the library for (e.g. "gymshark"). Required: the current sources cannot list ads by advertiser id alone.max 200 chars
advertiserIdstring- Library advertiser business id (adv_biz_ids): keeps only that advertiser's ads from the keyword results.pattern: ^\d{5,25}$
regionstring- Two-letter EEA/UK region code (e.g. DE, FR, GB). Set it to get only ads shown there (served by the fallback source); omit it for a library-wide search.exactly 2 chars
daysintegerdefault30- History window in days (1-365). Accepted for compatibility: the current sources return the newest ads first and do not apply a day window.1–365
sortenumdefault"last_shown_date,desc"- Sort order. Only last_shown_date,desc is served by the primary source; other orders use the fallback.one of: last_shown_date,desc, last_shown_date,asc, create_time,desc, create_time,asc, impression,desc, impression,asc
limitintegerdefault20- Maximum number of results to return (1-50, default 20).1–50
offsetintegerdefault0- Zero-based offset. Only 0 is supported: page with nextCursor instead.0–0
cursorstring- Opaque pagination cursor: pass the previous response's nextCursor.
Output
When output.found is true, output.data has these fields (a list under ads, billed per item returned).
adsobject[]ads[].idstring- Library ad id
ads[].adTitlestring | nullads[].advertiserNamestring | nullads[].advertiserIdstring | nullads[].urlstring | null- Public TikTok Ads Library detail URL
ads[].imagestring | null- Cover image
ads[].videoUrlstring | nullads[].formatstring | null- text | video | image (raw code when unknown)
ads[].statusstring | nullads[].firstShownUtcstring | nullads[].lastShownUtcstring | nullads[].estimatedAudiencestring | nulltotalinteger | nullhasMoreboolean | nulloffsetintegerregionstring | null- Region filter actually applied; null = library-wide
nextCursorstring | null
TypeScript type
/** output.data when output.found is true */
type TiktokAdTransparencySearch = {
ads: {
/** Library ad id */
id: string;
adTitle: string | null;
advertiserName: string | null;
advertiserId: string | null;
/** Public TikTok Ads Library detail URL */
url: string | null;
/** Cover image */
image: string | null;
videoUrl: string | null;
/** text | video | image (raw code when unknown) */
format: string | null;
status: string | null;
firstShownUtc: string | null;
lastShownUtc: string | null;
estimatedAudience: string | null;
}[];
total: number | null;
hasMore: boolean | null;
offset: number;
/** Region filter actually applied; null = library-wide */
region: string | null;
nextCursor: string | null;
};If what you asked about does not exist, is private, or a search matches nothing, the call still succeeds: output.found is false, output.data is null and output.reason says why. Such misses are free unless the notes below say misses are billed, in which case a miss costs the price of one call.
Pagination. Pass the previous response’s nextCursor as cursor to get the next page. nextCursor: null means there is nothing more. See Pagination.
Example response
Values are placeholders that follow the output schema (strings as "string", numbers as 0); credits shows what this call would cost at the usual price.
{
"output": {
"found": true,
"data": {
"ads": [
{
"id": "string",
"adTitle": "string",
"advertiserName": "string",
"advertiserId": "string",
"url": "https://example.com",
"image": "string",
"videoUrl": "https://example.com",
"format": "string",
"status": "string",
"firstShownUtc": "string",
"lastShownUtc": "string",
"estimatedAudience": "string"
}
],
"total": 0,
"hasMore": true,
"offset": 0,
"region": "string",
"nextCursor": null
}
},
"provider": "PrimaryAPI",
"credits": 3,
"items": 1,
"requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z",
"nextCursor": null
}Pricing and reliability
Calls go only to upstreams that are healthy right now. If an attempt fails, the call is retried automatically inside the same request; a failed attempt costs nothing, and a call never costs more than its quote’s maxCredits. Live figures below are measured on real traffic.
Success rate, uptime, latency and call counts are measured live from real traffic over 30 days and show “—” until there is data.
Errors
Errors are JSON { code, error, requestId } and are never charged. The ones to handle for this endpoint:
- invalid_inputThe request failed validation before anything ran.
- unauthorizedNo valid API key or session was presented.
- insufficient_balanceThe balance cannot cover the most this call could cost.
- key_limit_reachedThe key’s own spend limit is used up for the current window.
- trial_cap_reachedAn agent trial key has used its whole trial budget.
- forbiddenThe credential is valid but may not do this.
- not_foundThe thing addressed by the URL does not exist for you.
- idempotency_conflictThe
Idempotency-Keyis already bound to a different request. - rate_limitedToo many requests in the current window.
- all_sources_failedThe call could not be answered, even after automatic retries.
- service_unavailableThis API cannot run in this deployment right now.
- timeoutThe request passed its deadline before it finished.
Notes
Same library and vendor routes as tiktok.ad_library_search. A `limit` below the source page size drops the rest of that page.
More TikTok endpoints
- TikTok Ad Library Ad2 credits
- TikTok Ad Library Search3 credits
- TikTok Audience Demographics62 credits
- TikTok Comment Replies2 credits
- TikTok Followers2 credits
- TikTok Following2 credits
- TikTok Hashtag Search3 credits
- TikTok Hashtag Videos3 credits
- TikTok Keyword Search2 credits
- TikTok Live2 credits
- TikTok Photos2 credits
- TikTok Playlist Videos2 credits
- TikTok Profile2 credits
- TikTok Profile Contact Info3 credits
- TikTok Profile Region2 credits
- TikTok Profile Reposts2 credits
- TikTok Profile Videos2 credits
- TikTok Search Suggestions2 credits
- TikTok Song2 credits
- TikTok Song Videos2 credits
- TikTok Top Ads Search2 credits
- TikTok Top Search2 credits
- TikTok Trending Feed3 credits
- TikTok Trending Hashtags2 credits
- TikTok User Search2 credits
- TikTok Video1 credit
- TikTok Video Comments2 credits
- TikTok Video Download1 credit
- TikTok Video Transcript2 credits
- TikTok Video Transcript (Speech to Text)3 credits
- TikTok Photo SearchPlanned
- TikTok Profile PlaylistsPlanned
- TikTok User StoriesPlanned
Generated from the PrimaryAPI catalog. Machine-readable contract: GET https://api.primaryapi.com/v1/apis/tiktok.ad_transparency_search.