tiktok

Search TikTok users

Searches TikTok for user accounts matching a query, 30 per page. Each row carries the username, display name, avatar, profile URL, verification status, whether the account is private, and the follower, following, video and like counts. The search surface publishes nothing else, so on a plain call author.bio, author.location, author.ext.bio_link and author.ext.business_category are null on every row. Send include=profile and every row is joined, in the same call, to the profile lookup that carries them: the bio, the ISO 3166-1 alpha-2 region at author.location, the link in the bio and the account category land on each row. Cost: 1 credit for the page plus 1 credit per row filled from a fresh lookup (30 rows, so 31 at most); rows already in cache are filled for free, rows that could not be filled are refunded, and a repeat of the same call within the cache window is 0. Time: a plain call is about 2 seconds; include=profile adds 4 to 9 seconds on a fresh page (the lookups run in parallel and the call waits for the slowest, never more than 12 seconds) and nothing when the rows are already cached. limit=N (1 to 30) takes the top N rows of the page and, with include, caps the extra credits at N. The response carries a hydration block itemising rows, lookups, cache hits, credits and milliseconds. The counts on a search row are the search index's own figures and can trail the profile's by a few thousand on a large account; the join never overwrites a value the row already carries. Page with cursor. Send country= as an ISO 3166-1 alpha-2 code (KR, US, DE, …) to search for creators whose account region is that country instead of the global page: each returned row already carries author.location, the bio and the profile URL, the call does not paginate, and a row whose region does not match is dropped. Cost: 5 credits per in-country creator returned (8 by default, at most 20 via limit); unused slots are refunded. A typo is a free 400. The global 1-credit page is unchanged when country is omitted.

get/tiktok/search/users

Request

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

Query parameters

querystring required

Search keyword or phrase to find TikTok users

cursorinteger

Cursor to get more users. Get 'cursor' from previous response.

trimboolean

Accepted for compatibility; the response is already the canonical shape, so this flag has no effect.

include'profile'

Set to profile (one token only) to fill author.bio, author.location (the ISO region), author.ext.bio_link and author.ext.business_category on every row in this one call. Holds 1 credit per row (at most 30, or limit) and keeps only the rows filled from a fresh lookup; rows already in cache and rows that could not be filled are refunded, so the most a call can cost is 1 + rows. Adds 4 to 9 seconds on a fresh page (never more than 12) and nothing when the rows are already cached; read data.hydration for the rows, the credits held and kept, and the time.

limitinteger

Take the top N rows of the page (1 to 30) after the search has run. With include=profile it also caps the extra credits at N: limit=5&include=profile costs at most 6. With country= it is the in-country page size (1 to 20, default 8) and the credit cap at 5 per row. On the global page it is not a page size: next_cursor still advances past the full page, so rows beyond N on this page are not returned by the next page.

country'US' | 'GB' | 'CA' | 'AU' | 'NZ' | 'IE' | 'DE' | 'FR' | 'ES' | 'IT' | 'PT' | 'NL' | 'BE' | 'CH' | 'AT' | 'SE' | 'NO' | 'DK' | 'FI' | 'IS' | 'PL' | 'CZ' | 'SK' | 'HU' | 'RO' | 'BG' | 'GR' | 'HR' | 'RS' | 'SI' | 'UA' | 'RU' | 'TR' | 'IL' | 'AE' | 'SA' | 'QA' | 'KW' | 'EG' | 'MA' | 'ZA' | 'NG' | 'KE' | 'GH' | 'TZ' | 'ET' | 'BR' | 'MX' | 'AR' | 'CO' | 'CL' | 'PE' | 'VE' | 'EC' | 'UY' | 'PY' | 'BO' | 'CR' | 'PA' | 'DO' | 'JM' | 'JP' | 'KR' | 'CN' | 'TW' | 'HK' | 'MO' | 'SG' | 'MY' | 'ID' | 'TH' | 'VN' | 'PH' | 'IN' | 'PK' | 'BD' | 'LK' | 'NP' | 'MM' | 'KH'

ISO 3166-1 alpha-2 account region to filter by (KR, US, DE, …). Returns only creators whose public region is that country, 5 credits per row returned (8 by default, at most 20). Omit it for the global 1-credit page. A code this endpoint does not accept is a free 400.

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/search/users",
  "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.