tiktokshop

Get TikTok Shop product details

Returns detailed information about a TikTok Shop product: price and discount, rating, review count, stock availability, variants, category, seller details (rating, followers, positive-feedback percent, 24-hour response rate, and lifetime units sold), and images. Send include=details to add the full listing description, brand, specifications, the shipping fee and delivery estimate, and the official-shop badge, for 3 extra credits kept only when the description comes back. Identify the product by url or by product_id; shop.tiktok.com product links are accepted too. Region: default US. SG, MY, TH, VN and PH product lookups are served, and carry the description, specifications and shipping on the plain call. GB and ID are temporarily unavailable and answer 503 without charge. Other regions are rejected before billing. tiktokshop/search, tiktokshop/products and tiktokshop/product/reviews keep the wider 16-market set.

get/tiktokshop/product

Request

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

Query parameters

urlstring

Full URL of the TikTok Shop product page (www.tiktok.com/shop/pdp/... or shop.tiktok.com/.../pdp/...). Provide this or product_id. (one of: url, product_id; at least one required)

product_idstring

Numeric TikTok Shop product id, as returned in product.id by tiktokshop/search, tiktokshop/products and tiktokshop/user/showcase. Provide this or url. (one of: url, product_id; at least one required)

region'US' | 'GB' | 'ID' | 'MY' | 'TH' | 'SG' | 'VN' | 'PH'

ISO 3166-1 alpha-2 region for the lookup. Default US. Served: US, SG, MY, TH, VN, PH. GB and ID are temporarily unavailable (503, no charge). Other values are rejected before billing.

include'details'

Set to details (one token only) to add the listing description (product.description), brand, specifications, and the shipping fee, free-shipping flag, delivery estimate and official-shop badge (shop_identity) under product.ext.tiktokshop when the plain call came back without them. 3 extra credits, kept only when a description comes back; a repeat within the cache window is 0. Adds about 5 to 15 seconds when a lookup runs; read data.hydration for the credits held and kept and the time.

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