tiktokshop

TikTok Shop units sold and estimated sales per market

Runs one keyword through TikTok Shop search in each market you name and returns, per market: how many listings came back (listings, listings_with_sales), their lifetime units sold added up (units_sold), an estimate of sales in the market's own currency (estimated_sales, each listing's units times its current price, currency), and the top listings by units (top_products, each with id, title, url, price, units_sold and estimated_sales). These are lifetime units of the listings on the first search page at today's price, and TikTok can return a different first page on a repeat call, so compare markets within one call; the figures are not a period total or the whole market. For sales over a period, call it on a schedule and take the difference between two calls. Each market is one call to /v1/tiktokshop/search at that endpoint's own price, so every row behind the numbers is the row that endpoint returns; a market that found nothing or failed costs nothing and reports status empty or failed with null figures, never 0. data.regions[].credits and request_id show each market's own call.

get/tiktokshop/sales

Request

  • Base URL: https://www.socialcrawl.dev/v1
  • URL: https://www.socialcrawl.dev/v1/tiktokshop/sales
  • Auth: API key in header x-api-key

Query parameters

querystring required

Product keyword, sent unchanged to each market's search (1-200 characters).

regionsstring

Comma-separated markets, up to 8: US, GB, DE, FR, IT, ES, IE, ID, MY, MX, PH, SG, TH, VN, BR, JP. Default US. Each market costs one search page (1 credit) when it returns listings.

topinteger

How many top listings by units to return per market, 1 to 20. Default 5.

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": "tiktokshop",
  "endpoint": "/v1/tiktokshop/sales",
  "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"
    }
  }
}

Changes

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