SocialScrape
Get early access
Docs menu

Get started

Guides

API reference

Resources

TikTok Shop products of a shop

Beta GET /v1/tiktok/shop/products

GET /v1/tiktok/shop/products

Every product of one shop; parent is the shop's profile (first page). 20 products a page in TikTok's own order, which puts a shop's best sellers first. sort=new_releases reads the whole catalogue (up to 120 products) and orders it newest first by product id, so it ignores the cursor and returns one page. US catalogue only.

  • Cost: 1 credit
  • Status: Beta. Built and tested against recorded responses; the shape may still gain fields.
  • Cache: Results are kept up to 30 days; send max_age_days to reuse them for free.
  • Timeout: A request still running after about 25 seconds answers 202 with a job to poll (Batch and jobs).

Parameters#

NameTypeRequiredDescription
urlURLyesShop URL (tiktok.com/shop/store/<name>/<id>). Accepted hosts: tiktok.com.
sortstringnoOrder of results. Changing it restarts the cursor chain. One of top, new_releases. Default top. Also accepted as sort_by, sortBy, order.

Every request also accepts:

  • cursor: the cursor from the previous page (Pagination).
  • region: two-letter country code for results that vary by country. Changing it restarts the cursor chain.
  • trim: true for a smaller response without null fields and extra.
  • raw: true to also get the platform's original object as raw.
  • max_age_days: accept a cached result up to this many days old, for 0 credits (Caching).

Example request#

Set your key in the environment first (see Authentication).

curl
curl -G "https://api.socialscrape.io/v1/tiktok/shop/products" \
  -H "x-api-key: $SOCIALSCRAPE_API_KEY" \
  --data-urlencode "url=https://www.tiktok.com/shop/store/goli-nutrition/7495794203056835079"
Python
import os
import requests

params = {
    "url": "https://www.tiktok.com/shop/store/goli-nutrition/7495794203056835079",
}
res = requests.get(
    "https://api.socialscrape.io/v1/tiktok/shop/products",
    headers={"x-api-key": os.environ["SOCIALSCRAPE_API_KEY"]},
    params=params,
)
body = res.json()

if body["ok"]:
    print(body["data"])
else:
    print(body["error"]["code"], body["error"]["message"])
TypeScript
const url = new URL("https://api.socialscrape.io/v1/tiktok/shop/products");
url.search = new URLSearchParams({
  "url": "https://www.tiktok.com/shop/store/goli-nutrition/7495794203056835079"
}).toString();
const res = await fetch(url, {
  headers: { "x-api-key": process.env.SOCIALSCRAPE_API_KEY! },
});
const body = await res.json();

if (body.ok) {
  console.log(body.data);
} else {
  console.error(body.error.code, body.error.message);
}
n8n
{
  "nodes": [
    {
      "name": "SocialScrape TikTok Shop products of a shop",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        0,
        0
      ],
      "parameters": {
        "method": "GET",
        "url": "https://api.socialscrape.io/v1/tiktok/shop/products",
        "sendQuery": true,
        "queryParameters": {
          "parameters": [
            {
              "name": "url",
              "value": "https://www.tiktok.com/shop/store/goli-nutrition/7495794203056835079"
            }
          ]
        },
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "x-api-key",
              "value": "={{ $env.SOCIALSCRAPE_API_KEY }}"
            }
          ]
        }
      }
    }
  ],
  "connections": {}
}

Example response#

This is a sample from a recorded response, lists and long text are shortened, dash characters in the text are replaced with hyphens. Status 200.

{
  "ok": true,
  "credits_charged": 1,
  "credits_remaining": 4999,
  "cached": false,
  "cached_at": null,
  "request_id": "req_b0074802ede3c6d7f03c29f6",
  "data": {
    "object": "list",
    "items": [
      {
        "object": "product",
        "platform": "tiktok",
        "id": "1729527313880355335",
        "url": "https://www.tiktok.com/shop/pdp/ashwagandha-gummies-by-goli-ksm-66-mixed-berry-vegan-non-gmo/1729527313880355335",
        "title": "Goli Ashwagandha & Vitamin D Gummy - Mixed Berry, KSM-66, Vegan, Plant Based, Non-GMO, Gluten-Free & Gelatin Free. America's #1 Ashwagandha Brand",
        "description": null,
        "price": {
          "amount": 19.47,
          "currency": "USD",
          "original_amount": 24.7,
          "display": "$19.47"
        },
        "seller": {
          "id": "7495794203056835079",
          "handle": null,
          "name": "Goli Nutrition",
          "url": null,
          "avatar_url": "https://p16-oec-general-useast5.ttcdn-us.com/tos-useast5-i-omjb5zjo8w-tx/e7478d3e93d4487a9e772fa74e10f506~tplv-fhlh96nyum-resize-png:300:300.png?dr=12184&t=555f072d&ps=933b5bde&shp=905da467&shcp=d9d491bf&idc=useast5&from=2422056039",
          "verified": null
        },
        "rating": 4.5,
        "review_count": 94470,
        "sold_count": 1306215,
        "image_urls": [
          "https://p16-oec-general-useast5.ttcdn-us.com/tos-useast5-i-omjb5zjo8w-tx/2bc69aa9f6084480beee1bb4a8db3a69~tplv-fhlh96nyum-crop-webp:1500:1500.webp?dr=12190&t=555f072d&ps=933b5bde&shp=8dbd94bf&shcp=a6e80448&idc=useast5&from=2378011839"
        ],
        "category": null,
        "in_stock": null,
        "location": null,
        "published_at": null,
        "extra": {
          "brand": "Goli",
          "discount": "21%",
          "labels": [
            "Free shipping"
          ],
          "sku_id": "1729527298861535751"
        }
      },
      {
        "object": "product",
        "platform": "tiktok",
        "id": "1731194857673101831",
        "url": "https://www.tiktok.com/shop/pdp/zero-sugar-best-seller-trio-goli-ashwagandha-gummies-vegan-non-gmo/1731194857673101831",
        "title": "Goli Zero Sugar Best Seller Trio - Daily Gut & Wellness Support with Pre, Post & Probiotics, Apple Cider Vinegar, Ashwagandha & L-Theanine Gummies",
        "description": null,
        "price": {
          "amount": 49.37,
          "currency": "USD",
          "original_amount": 74.1,
          "display": "$49.37"
        },
        "seller": {
          "id": "7495794203056835079",
          "handle": null,
          "name": "Goli Nutrition",
          "url": null,
          "avatar_url": "https://p16-oec-general-useast5.ttcdn-us.com/tos-useast5-i-omjb5zjo8w-tx/e7478d3e93d4487a9e772fa74e10f506~tplv-fhlh96nyum-resize-png:300:300.png?dr=12184&t=555f072d&ps=933b5bde&shp=905da467&shcp=d9d491bf&idc=useast5&from=2422056039",
          "verified": null
        },
        "rating": 4.4,
        "review_count": 49061,
        "sold_count": 1041805,
        "image_urls": [
          "https://p16-oec-general-useast5.ttcdn-us.com/tos-useast5-i-omjb5zjo8w-tx/02f1b939f53d400998099bfad0f85a14~tplv-fhlh96nyum-crop-webp:3000:3000.webp?dr=12190&t=555f072d&ps=933b5bde&shp=8dbd94bf&shcp=a6e80448&idc=useast5&from=2378011839"
        ],
        "category": null,
        "in_stock": null,
        "location": null,
        "published_at": null,
        "extra": {
          "brand": "Goli",
          "discount": "33%",
          "labels": [
            "Free shipping"
          ],
          "sku_id": "1731194889857176071"
        }
      }
    ],
    "cursor": "eyJzIjoiNzQ5NTc5NDIwMzA1NjgzNTA3OSIsInNwIjoiMjBfV3pNM05qUXpMRFUzTURBd01EQXdMREUzTkRjek16TTNNRFF6TURBc0lqRTNNekV4TnpNM01ETTBOelU1TlRneU56a2lYUT09IiwibyI6MjB9",
    "has_more": true,
    "parent": {
      "object": "profile",
      "platform": "tiktok",
      "id": "7495794203056835079",
      "handle": null,
      "name": "Goli Nutrition",
      "headline": null,
      "url": "https://www.tiktok.com/shop/store/goli-nutrition/7495794203056835079",
      "kind": "shop",
      "bio": "Shop Goli Nutrition on TikTok Shop! 5.8M sold, 601.5K+ followers. 89+% positive feedback. 0+% Ships in 48h, 99+% replies in 24h. Join the trend!",
      "avatar_url": "https://p16-oec-general-useast5.ttcdn-us.com/tos-useast5-i-omjb5zjo8w-tx/e7478d3e93d4487a9e772fa74e10f506~tplv-fhlh96nyum-resize-webp:300:300.webp?dr=12185&t=555f072d&ps=933b5bde&shp=905da467&shcp=8dbd94bf&idc=useast5&from=2422056039",
      "banner_url": null,
      "verified": null,
      "is_private": null,
      "external_url": null,
      "links": [
        {
          "title": "TikTok Shop",
          "url": "https://www.tiktok.com/shop/store/goli-nutrition/7495794203056835079"
        }
      ],
      "location": null,
      "category": null,
      "created_at": null,
      "stats": {
        "followers": 601537,
        "following": null,
        "posts": 5637,
        "likes": null,
        "views": null
      },
      "extra": {
        "creator_name": "Goli® Nutrition",
        "identity": "OFFICIAL SHOP",
        "product_count": 53,
        "rating": 4.6,
        "region": "US",
        "review_count": 412514,
        "scores": [
          {
            "score": 99.0,
            "type": 1
          },
          {
            "score": 0.0,
            "type": 2
          },
          {
            "score": 89.0,
            "type": 3
          }
        ],
        "sold_count": 5808324,
        "video_count": 5637
      }
    }
  },
  "cursor": "eyJzIjoiNzQ5NTc5NDIwMzA1NjgzNTA3OSIsInNwIjoiMjBfV3pNM05qUXpMRFUzTURBd01EQXdMREUzTkRjek16TTNNRFF6TURBc0lqRTNNekV4TnpNM01ETTBOelU1TlRneU56a2lYUT09IiwibyI6MjB9",
  "has_more": true
}

Response#

A list of Product objects in data.items, with data.cursor and data.has_more.

See Data models for every field. The envelope around data is described in Responses.

Errors#

Failures are free: credits_charged is 0. Branch on error.code, never on the message.

CodeHTTPRetryMeaning
invalid_params400noA parameter is missing, unknown or has the wrong type.
unsupported_url400noThe URL is not one this endpoint accepts (wrong platform or form).
not_found404noThe platform says this profile, post or item does not exist.

Every request can also fail with the account and platform errors listed on the Errors page.

Example error:

{
  "ok": false,
  "error": {
    "code": "not_found",
    "message": "The platform says this profile, post or item does not exist.",
    "retryable": false
  },
  "credits_charged": 0,
  "request_id": "req_c718ca683eced44b07c144bd"
}