tiktok.adlibrary_ad

beta 2 credits needs a pack

Get a TikTok Ad Library ad.

GET /v1/tiktok/adlibrary_ad

What you get#

One TikTok record in Onekey's unified shape, in data. If the record does not exist you get a 404 not_found and are not charged.

Also known as: /tiktok/adlibrary/ad on APIs that nest their paths. See Alternatives and equivalents.

What it costs#

2 credits for a fresh fetch, charged only when it succeeds.
Free when served from cache (0.2 credit for a cached response over 100 KB).
Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

Name	Type	Required	Default	What it is	Constraints
`url`	string	no	-	Url (URL)	max 500 chars; must match `https?://[^\s]{4,480}`; trimmed
`ad_id`	string	no	-	Ad id in the TikTok ad library (alternative to url)	max 30 chars; must match `[0-9]{6,30}`; trimmed

Request#

curl "https://api.onekey.dev/v1/tiktok/adlibrary_ad?url=https%3A%2F%2Fwww.tiktok.com%2F%40natgeo%2Fvideo%2F7123456789012345678" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real TikTok response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json

{
  "success": true,
  "data": {
    "entity": {
      "id": "8001",
      "status": "active",
      "url": "https://example.com/ad/8001"
    },
    "author": {
      "displayName": "Sample Brand"
    },
    "content": {
      "text": "Sample ad copy",
      "createdAt": "2025-01-01T00:00:00Z"
    },
    "media": {
      "url": "https://example.com/ad.mp4"
    },
    "engagement": {
      "views": 10000,
      "likes": 50
    }
  },
  "metadata": {
    "platform": "tiktok",
    "endpoint": "adlibrary_ad",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 2,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source path	Onekey field	Transform
`id`	`entity.id`	-
`page_name`	`author.displayName`	-
`text`	`content.text`	-
`start_date`	`content.createdAt`	`toIsoDate`
`status`	`entity.status`	-
`media_url`	`media.url`	`safeUrl`
`url`	`entity.url`	`safeUrl`
`impressions`	`engagement.views`	`toNumber`
`likes`	`engagement.likes`	`toNumber`

Caching and freshness#

Fresh for about 5 minutes. Repeat calls in that window are served from cache and are free.
Between 5 minutes and 1 hour the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
If the source is down when a refresh is needed, the last copy can be served for up to 1 day more (marked stale).
A "not found" is remembered for 1 minute and is free.
The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

Status	Code	What to do
401	`unauthorized`	Check the `x-api-key` header.
402	`insufficient_credits`	Add credits; your balance must cover the price.
404	`not_found`	That record does not exist. Free; do not retry.
422	`invalid_params`	Fix the parameters using the table above. Free.
429	`rate_limited`	Wait `Retry-After` seconds, then retry.
502	`upstream_error`	The source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: beta (not yet verified against the live source).