--- title: "List TikTok Shop products" method: GET path: "/tiktokshop/products" tags: ["tiktokshop"] --- # List TikTok Shop products `GET /tiktokshop/products` ## Request - Base URL: `https://www.socialcrawl.dev/v1` - URL: `https://www.socialcrawl.dev/v1/tiktokshop/products` - Auth: API key in header `x-api-key` Returns the products listed on one TikTok Shop storefront: title, images, canonical URL, price and original price, discount percent, sold count, review count, rating, SKU id, and the shop's own profile (name, rating, follower count, lifetime units sold, region). Sort by best-selling (`sort_by=top`) or newest (`sort_by=new_releases`); filter by `region`. Pages through the whole catalogue via `pagination.next_cursor`, and `data.total` carries the storefront's on-sale product count. ## Query parameters - `url` string, required - `sort_by` 'top' | 'new_releases' - `region` 'US' | 'GB' | 'DE' | 'FR' | 'IT' | 'ID' | 'MY' | 'MX' | 'PH' | 'SG' | 'ES' | 'TH' | 'VN' | 'BR' | 'JP' | 'IE' - `cursor` string ## Headers - `Cache-Control` string - `Idempotency-Key` string ## Response `200` Successful response - object - `success` boolean, required: Whether the request succeeded - `platform` string, required: Platform name - `endpoint` string, required: API endpoint path - `data` object, required: Platform-specific response data - `items` object[]: Array of canonical product wrappers ({ product }) - `product` object: Canonical Product object (unified across commerce platforms) - `id` string: Platform product ID (Amazon ASIN / Google Shopping product id) - `url` string, nullable: Direct URL to the product page - `title` string, nullable: Product title - `description` string, nullable: String at product.description - `seller` string, nullable: String at product.seller - `brand` string, nullable: Brand name (cleaned). Null when the platform exposes a seller instead. - `price` object: Price block (current, original/list, currency) - `current` integer, nullable: Numeric at product.price.current - `original` integer, nullable: Numeric at product.price.original - `currency` string, nullable: String at product.price.currency - `rating` object: Aggregate rating (average + number of ratings) - `average` integer, nullable: Numeric at product.rating.average - `count` integer, nullable: Numeric at product.rating.count - `image_urls` union: Primary image URL, or an array of image URLs for products with a gallery. - string - string[] - `availability` string, nullable: Stock/availability string when surfaced - `reviews_count` integer, nullable: Numeric at product.reviews_count - `features` string[], nullable: Array at product.features - `specifications` object[], nullable: Array at product.specifications - `group` string, nullable: String at product.specifications.group - `name` string, nullable: String at product.specifications.name - `value` string, nullable: String at product.specifications.value - `variations` object[], nullable: Array at product.variations - `id` string, nullable: String at product.variations.id - `title` string, nullable: String at product.variations.title - `url` string, nullable: String at product.variations.url - `category` string, nullable: String at product.variations.category - `ext` object, nullable: Nested object: product.ext - `gid` string, nullable: String at product.ext.gid - `data_docid` string, nullable: String at product.ext.data_docid - `pvf` string, nullable: String at product.ext.pvf - `seller_id` string, nullable: String at product.ext.seller_id - `sold_count` integer, nullable: Numeric at product.ext.sold_count - `bought_past_month` integer, nullable: Numeric at product.ext.bought_past_month - `bought_past_month_label` string, nullable: String at product.ext.bought_past_month_label - `catalog_id` string, nullable: String at product.ext.catalog_id - `requested_id` string, nullable: String at product.ext.requested_id - `rating_distribution` object, nullable: Nested object: product.ext.rating_distribution - `star_1` integer, nullable: Numeric at product.ext.rating_distribution.star_1 - `star_2` integer, nullable: Numeric at product.ext.rating_distribution.star_2 - `star_3` integer, nullable: Numeric at product.ext.rating_distribution.star_3 - `star_4` integer, nullable: Numeric at product.ext.rating_distribution.star_4 - `star_5` integer, nullable: Numeric at product.ext.rating_distribution.star_5 - `store_inventory` object[], nullable: Array at product.ext.store_inventory - `store_id` string, nullable: String at product.ext.store_inventory.store_id - `store_name` string, nullable: String at product.ext.store_inventory.store_name - `state` string, nullable: String at product.ext.store_inventory.state - `in_stock` boolean, nullable: Boolean at product.ext.store_inventory.in_stock - `quantity` integer, nullable: Numeric at product.ext.store_inventory.quantity - `fulfillment` string, nullable: String at product.ext.store_inventory.fulfillment - `service` string, nullable: String at product.ext.store_inventory.service - `location_type` string, nullable: String at product.ext.store_inventory.location_type - `is_selected_store` boolean, nullable: Boolean at product.ext.store_inventory.is_selected_store - `promotion` object, nullable: Nested object: product.ext.promotion - `label` string, nullable: String at product.ext.promotion.label - `amount_off` integer, nullable: Numeric at product.ext.promotion.amount_off - `percent_off` integer, nullable: Numeric at product.ext.promotion.percent_off - `price_note` string, nullable: String at product.ext.price_note - `condition` string, nullable: String at product.ext.condition - `available_quantity` integer, nullable: Numeric at product.ext.available_quantity - `watchers` integer, nullable: Numeric at product.ext.watchers - `sold_at` string, nullable: String at product.ext.sold_at - `sold_caption` string, nullable: String at product.ext.sold_caption - `buying_format` string, nullable: String at product.ext.buying_format - `seller_reputation` object, nullable: Nested object: product.ext.seller_reputation - `feedback_percentage` integer, nullable: Numeric at product.ext.seller_reputation.feedback_percentage - `feedback_count` integer, nullable: Numeric at product.ext.seller_reputation.feedback_count - `top_rated` boolean, nullable: Boolean at product.ext.seller_reputation.top_rated - `items_sold` integer, nullable: Numeric at product.ext.seller_reputation.items_sold - `joined` string, nullable: String at product.ext.seller_reputation.joined - `url` string, nullable: String at product.ext.seller_reputation.url - `detailed_ratings` object, nullable: Nested object: product.ext.seller_reputation.detailed_ratings - … - `g2` string, nullable: Leaf at product.ext.g2 - `etsy` string, nullable: Leaf at product.ext.etsy - `sephora` string, nullable: Leaf at product.ext.sephora - `hm` string, nullable: Leaf at product.ext.hm - `kohls` string, nullable: Leaf at product.ext.kohls - `gumtree` string, nullable: Leaf at product.ext.gumtree - `sku_id` string, nullable: String at product.ext.sku_id - `aliexpress` string, nullable: Leaf at product.ext.aliexpress - `tiktokshop` string, nullable: Leaf at product.ext.tiktokshop - `next_cursor` string, nullable: Opaque cursor for the next page. Pass it back as a query parameter on endpoints that support pagination. Present only when the upstream reports more results. - `total` integer, nullable: Total number of matching results, when the upstream provides a count. Omitted otherwise. - `dropped` integer, required: Number of upstream list items dropped because they could not be repaired to the endpoint schema. Valid list responses include 0. - `_warnings` string[]: Non-fatal notices about this response (field-map drift, clamped computed values). Advisory only: its presence never means the request failed. Omitted entirely when there is nothing to report, so treat absent as 'no warnings'. - `credits_used` integer, required: Number of credits consumed - `credits_remaining` integer, 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_id` string, required: Unique request identifier for support - `cached` boolean, required: Whether the response was served from cache - `idempotent_replay` boolean: True only when this response is an idempotency replay - `meta` object: Optional. Present only when this call completed a pattern that one other call does more cheaply or in one step, at most once per pattern per API key per day. Send the header `X-SocialCrawl-Hints: off` to never receive it. - `hint` object: One suggestion: what to call instead and why, with the price when the suggested call costs more than the calls it replaces. - `code` string: creator_card | batch_profiles | search_multi | incremental_sync | comment_labels | search_repeat - `message` string: One sentence for a person or an agent to read. - `method` string: GET or POST. - `path` string: The call the hint points to. - `pagination` object, required: Cursor state for this page. Present on every list response. - `next_cursor` string, nullable, required: Opaque token to send back as `cursor` for the next page, or null at end-of-list. Pass it back verbatim; never decode or trim it. - `has_more` boolean, required: Explicit stop signal. Prefer this over inspecting next_cursor or comparing against total. - `page_size` integer, required: Number of items in THIS page. - `stopped_at` 'since' | 'known_id' | 'end' | 'null', nullable: Present only when the request sent `since` or `stop_at_id`. Why the walk stopped: `since` (this page reached a post older than the date), `known_id` (this page reached the post you already hold), `end` (the list ran out first), or null (not yet, keep walking with `next_cursor`). ## Other responses - `400`: Invalid request - missing or malformed parameters - `401`: Unauthorized - missing or invalid API key - `402`: Payment required - the account balance is too low, or the calling key has spent its own per-key credit limit - `404`: Not found - the endpoint does not exist, or the requested resource was not found upstream - `405`: Method not allowed - wrong HTTP verb for this endpoint - `409`: Conflict - an idempotent request is still in flight, its completed body exceeded the replay limit, or the cohort resource is not in a state that allows this operation - `410`: Gone - the discover run's retention passed and its rows were deleted; start a new run - `413`: Payload too large: the JSON request body exceeds the 1 MB size limit and is rejected before parsing, or a single cohort result cannot fit beneath the 1 MB response-page ceiling - `422`: Idempotency payload mismatch - this Idempotency-Key was already used with a different request payload; or a discover request with async=false is over what one call can answer (NEEDS_ASYNC) - `429`: Rate or concurrency limit exceeded. `RATE_LIMITED`: more than 600 requests in a 1-minute sliding window on this API key (headers `X-RateLimit-Limit`/`Remaining`/`Reset`; `Retry-After` is seconds until the window resets). `CONCURRENCY_LIMIT`: more than 50 simultaneous in-flight requests (headers `X-Concurrency-Limit`/`Remaining`; short static `Retry-After`). Both are unbilled. Honor `Retry-After`, then back off with jitter. See /docs/rate-limits. - `500`: Internal server error - an immediate refund is attempted; credits_used reports the committed net charge and exact compensation is queued if that refund cannot commit - `502`: Upstream error - the platform returned an error; an immediate refund is attempted and credits_used reports the committed net charge - `503`: Service unavailable - the request is unbilled when rejected before deduction, otherwise an immediate refund is attempted and credits_used reports the committed net charge - `504`: Gateway timeout - the request was still running close to the platform time limit and is answered as UPSTREAM_ERROR, the same code as 502. An immediate refund is attempted and credits_used reports the committed net charge. When details.retry_with is set, retryable is false and there is no Retry-After --- [API](https://skmtc.dev/socialcrawl/apis/socialcrawl-api.md) · [All operations](https://skmtc.dev/socialcrawl/apis/socialcrawl-api/llms.txt) · [OpenAPI document](https://skmtc.dev/socialcrawl/apis/socialcrawl-api/revisions/a0ad2511004a?raw)