tiktok

Read TikTok's own Top Videos board for the US, Japan, Vietnam, Thailand or Indonesia. Metered: 25 credits per board plus 1 per video returned

Returns the videos TikTok itself ranks at the top of its Top Videos board for a market over the last 7 or 30 days, sorted by views, engagement or 6-second views. Each row is a video: id, url, the caption at content.text, the cover and a video file URL (signed, expires within hours), the creator at author.username / author.display_name with ext.author_id and ext.author_followers, the upload time at published_at, and lifetime views at engagement.views. What the board says about it is on ext.trend: rank, period_views (views inside the window), organic_views, engagement_rate, six_second_view_through_rate and TikTok's content_tags. Markets: TikTok publishes this board for US, JP, VN, TH and ID only. Any other market, Germany included, is refused with a 400 at no charge; for those markets use /v1/tiktok/hashtags/popular, which covers 27. The board carries no like, comment or share counts and no duration, so those leaves are null rather than estimated. It includes paid and branded posts; organic_views is the only paid-versus-organic signal TikTok gives. A logged-out reader of TikTok's page sees the top four, and ranks 1 to 4 were checked against it; deeper ranks follow TikTok's order as served. Pricing is metered at 25 credits per board plus 1 credit per video returned (20 videos = 45 credits), because each read of the board has a fixed cost. An empty board costs nothing.

get/tiktok/videos/popular

Request

  • Base URL: https://www.socialcrawl.dev/v1
  • URL: https://www.socialcrawl.dev/v1/tiktok/videos/popular
  • Auth: API key in header x-api-key

Query parameters

countryCode'US' | 'JP' | 'VN' | 'TH' | 'ID'

Market: US, JP, VN, TH or ID, the only markets TikTok publishes this board for. Defaults to US.

period'7' | '30'

Window in days: 7 or 30. Defaults to 7.

orderBy'views' | 'engagement' | 'six_second_views'

How TikTok ranks the board: views (the default), engagement, or six_second_views.

limitinteger

How many videos to return, 1-20, default 20.

sincestring

Only rows published on or after this date: YYYY-MM-DD (midnight UTC) or an ISO 8601 timestamp. Rows older than it are left off each page. This list is not in date order, so the walk does not stop at the date: keep following next_cursor, and each page costs what a page costs even when every row on it is filtered out. A row with no date is kept. published_after, start_date, from_date, publish_time (yesterday, this-week, this-month, last-3-months, last-6-months) and max_age_days are accepted and applied as since.

untilstring

Only rows published on or before this date: YYYY-MM-DD (that whole UTC day is included) or an ISO 8601 timestamp. Newer rows are left off each page and the walk does not stop, so older pages follow. A row with no date is kept. published_before, end_date and to_date are accepted and applied as until.

Headers

Cache-Controlstring

Send no-cache to bypass the response cache and force a live fetch. Billed at the normal endpoint cost; the fresh result is written back to cache for the next caller. Only the no-cache directive triggers this. See the Response Schema guide for details.

Idempotency-Keystring

Optional UUID that makes the request safely retriable. The key is reserved atomically per account before billing. A concurrent retry receives 409 IDEMPOTENCY_IN_PROGRESS with a Retry-After of 1 second while the original is young, growing to a quarter of the time it has been running (at most 30); a crashed reservation expires after 5 minutes. A replay keeps the cached payload immutable except for billing metadata: credits_used becomes 0, idempotent_replay becomes true, and credits_remaining is refreshed to the current balance. A known current balance appears in both the body and X-Credits-Remaining header; no balance row resolves to 0. On a transient lookup failure, body credits_remaining is null and X-Credits-Remaining is omitted. Completed outcomes expire after 24 hours. If the claim store is unavailable, the request fails closed before billing. GET endpoints do not combine idempotent replay with Server-Sent Events: use Accept: application/json when sending this header. The unsupported key-plus-SSE combination is rejected before billing.

Response

Successful response

successboolean required

Whether the request succeeded

platformstring required

Platform name

endpointstring required

API endpoint path

credits_usedinteger required

Number of credits consumed

credits_remaininginteger nullable required

Current account balance, or null when this response could not establish one. Free cache hits always return null because they do not establish an authoritative post-request balance. An idempotency replay also returns null when its current-balance lookup fails. It is never a fabricated zero, so a zero here means the account really is empty. The authoritative reading is the one on a billed response, which comes straight from the deduction.

request_idstring required

Unique request identifier for support

cachedboolean required

Whether the response was served from cache

idempotent_replayboolean

True only when this response is an idempotency replay

Example response

{
  "success": true,
  "platform": "tiktok",
  "endpoint": "/v1/tiktok/videos/popular",
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "req-abc123",
  "idempotent_replay": true,
  "meta": {
    "hint": {
      "code": "search_multi",
      "message": "You searched \"matcha\" on 3 platforms one call at a time; /v1/search/multi returns each platform's own search rows in one call at the same price per platform, and a platform with no rows is not charged.",
      "method": "GET",
      "path": "/v1/search/multi?query=matcha&platforms=instagram,tiktok,youtube"
    }
  },
  "pagination": {
    "next_cursor": "sc.eyJ2IjoyLCJjIjoiMiIsInAiOiJwYWdlIn0",
    "has_more": true,
    "page_size": 30,
    "stopped_at": "known_id"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.