tiktok.videos_popular

beta 3 credits needs a pack

Top Videos board for a supported market.

GET /v1/tiktok/videos_popular

What you get#

A list of TikTok results in Onekey's unified shape, in data (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free 404 not_found instead.

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

What it costs#

3 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
`country`	string	no	`US`	Country	max 2 chars; must match `[A-Za-z]{2}`; trimmed

Request#

curl "https://api.onekey.dev/v1/tiktok/videos_popular" \
  -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": "11001",
        "name": "sampletrend",
        "url": "https://example.com/t/sampletrend"
      },
      "ext": {
        "rank": 1,
        "postCount": 9000,
        "hotValue": 1234567,
        "ctr": 0.04
      },
      "engagement": {
        "views": 50000,
        "likes": 2000
      },
      "media": {
        "thumbnailUrl": "https://example.com/t.jpg"
      }
    }
  ],
  "metadata": {
    "platform": "tiktok",
    "endpoint": "videos_popular",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 3,
    "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`	-
`name`	`entity.name`	-
`url`	`entity.url`	`safeUrl`
`rank`	`ext.rank`	`toNumber`
`post_count`	`ext.postCount`	`toNumber`
`hot_value`	`ext.hotValue`	`toNumber`
`view_count`	`engagement.views`	`toNumber`
`like_count`	`engagement.likes`	`toNumber`
`ctr`	`ext.ctr`	`toNumber`
`thumbnail_url`	`media.thumbnailUrl`	`safeUrl`

Caching and freshness#

Fresh for about 1 minute. Repeat calls in that window are served from cache and are free.
Between 1 minute and 5 minutes 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 hour 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`	Unknown endpoint path.
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).