Skip to content

Structured TikTok data: every input is optional. Cursor-paginated, 1 credit per successful call.

GET · POST1 credit / successful callCursor-paginated
GEThttps://api.scrapier.io/api/v2/tiktok-shop-data-scraper/Open in Playground

Call GET /api/v2/tiktok-shop-data-scraper/. The results are in data.products; send data.next_cursor back as cursor to get the next page. 7 optional parameters refine the call (see Parameters).

Terminal window
curl -G "https://api.scrapier.io/api/v2/tiktok-shop-data-scraper/" \
-H "X-API-Key: YOUR_API_KEY" \
--max-time 210
NameTypeRequiredDefaultDescription
X-API-Key headerstringyes—Your API key from the dashboard.
queriesstringnoshoesTikTok Shop product search keyword (keyword mode). Required first call unless a url is given. Aliases: searchKeywords, query, q.
urlsstringno—Product /pdp/, category /c/, or seller /store/ URL (URL mode — takes precedence over queries). Aliases: startUrls.
cursorstringno—Pagination cursor returned in the previous response's next_cursor. Pass it back unchanged to fetch the next page. When next_cursor is null, you have reached the last page.
include_reviewsbooleannofalseFetch embedded product reviews.
locked in cursor
max_detailsintegerno4Products per call that get the full product-page enrichment (creators, stock, reviews); the rest are returned from listing data (source="listing"). Each enriched product costs ~65 KB of proxy traffic. 0 = listing only; raise (e.g. 100) to enrich everything. Defaults to all when include_reviews is true.
max_reviewsintegerno10Max reviews per product (1-100).
locked in cursor
sort_by_sold_countstringnononenone | highest_first | lowest_first.
nonehighest_firstlowest_first
locked in cursor
Advanced
NameTypeDefaultDescription
use_proxybooleantrueRoute the request through Scrapier's residential proxy pool. Default: true. Leave as is unless support tells you otherwise.
raw_databooleanfalseWhen true, the response carries the full raw upstream payload(s) the scraper received (GraphQL / JSON API bodies, HTML, embedded JSON-LD -- exactly as the platform returned them) under raw_responses, in place of the formatted items. When false (default) you get the formatted output. Pagination (cursor / next_cursor) works the same in both modes.
{
"success": true,
"data": {
"queries": "shoes",
"page": 1,
"page_size": 20,
"products": [
{
"product_id": "1732119583850205647",
"title": "Women's Low-Top Sports Shoes, Lightweight Breathable Thick Sole",
"url": "https://shop.tiktok.com/us/pdp/1732119583850205647",
"price": 36.27,
"currency": "USD",
"rating": 4.7,
"review_count": 193,
"seller_id": "8652615273335460303",
"seller_name": "Juyu Footwear",
"sold_count": 2585,
"is_sold_out": false,
"creator_count": 17,
"has_creator_data": true,
"total_creator_videos": 20,
"scraped_at": "2026-06-18T12:00:00.000Z",
"source": "product_page"
}
],
"next_cursor": "eyJpIjoic2hvZXMiLCJrIjoicSIsImxrIjp7fSwibyI6MjAsInAiOjIsInMiOiIiLCJ0IjoiMjAyNjEwMDEwOTA2MjA5NUI1QjcxRDY0RjE2NzMzODM1OCJ9"
}
}

Sample from the live catalog; arrays trimmed to 3 items. Results are in data.products.

FieldTypeExampleDescription
queriesstringshoes—
pageinteger1—
page_sizeinteger20—
productsarray[1 item]The results.
next_cursorstringeyJpIjoic2hvZXMiLCJrIjoicSIsImxrIjp7fSwibyI6M…Pass back as cursor for the next page. null on the last page.
products[].product_idstring1732119583850205647—
products[].titlestringWomen's Low-Top Sports Shoes, Lightweight Bre…—
products[].urlstringhttps://shop.tiktok.com/us/pdp/17321195838502…—
products[].pricenumber36.27—
products[].currencystringUSD—
products[].ratingnumber4.7—
products[].review_countinteger193—
products[].seller_idstring8652615273335460303—
products[].seller_namestringJuyu Footwear—
products[].sold_countinteger2585—
products[].is_sold_outbooleanfalse—
products[].creator_countinteger17—
products[].has_creator_databooleantrue—
products[].total_creator_videosinteger20—
products[].scraped_atstring2026-06-18T12:00:00.000Z—
products[].sourcestringproduct_page—

Pass data.next_cursor back as cursor until it is null. Required inputs are ignored once a cursor is sent. Each page is one billed call. More in Pagination.

const url = "https://api.scrapier.io/api/v2/tiktok-shop-data-scraper/";
let params = {};
const items = [];
for (let page = 0; page < 10; page++) { // each page is one billed call
const res = await fetch(`${url}?${new URLSearchParams(params)}`, {
headers: { "X-API-Key": "YOUR_API_KEY" },
signal: AbortSignal.timeout(210_000),
});
const body = await res.json();
if (!res.ok) throw new Error(body.error ?? body.detail ?? `HTTP ${res.status}`);
const data = body.data;
items.push(...(data.products ?? []));
if (!data.next_cursor) break; // null = last page
params = { cursor: data.next_cursor };
}

Failed calls are free. Branch on the HTTP status and read the message from error (or detail). Full details in Errors.

StatusMeaningRetry?Charged?
400Bad or missing input.No — fix the paramsNo
401 / 403Missing, invalid or revoked API key.No — fix the keyNo
402Out of credits (body has balance).No — top upNo
404Unknown endpoint slug.No — check the slugNo
429 / 503Busy or throttled.Yes — after Retry-AfterNo
5xxTarget site or upstream failure, or timeout.Yes — with backoffNo
  • Locked into the cursor: include_reviews, max_reviews, sort_by_sold_count. Set them on the first call; later pages reuse them.
  • TikTok Ad Library Leads — Structured TikTok data: every input is optional. Single lookup, 3 credits per successful call.
  • TikTok Ad Library — Structured TikTok data: send urls. Cursor-paginated, 1 credit per successful call.
  • TikTok Ads Top — Structured TikTok data: every input is optional. Cursor-paginated, 1 credit per successful call.
  • TikTok Collection Videos — Structured TikTok data: send urls. Cursor-paginated, 1 credit per successful call.