Get related products

Try in Playground

Read what a product page recommends: creator videos tagged with the product, more products from the same store and similar products from other stores.

GET/v1/tiktok/product/relatedx-api-key

Headers

Get your API key

x-api-keystringrequiredheader

Your ScrapeAtlas customer key. Create one on /account/ and set SCRAPEATLAS_API_KEY.

Query parameters

product_idstringquery

TikTok Shop product ID (15-22 digits); provide either product_id or url.

Example1729000000000000001

urlstringquery

Public product URL in any form the product endpoint accepts.

max 2048 chars

regionenumdefault: "US"query

Storefront region, US (default).

one of: US · default: "US"

Response fields

133

requestIdstring

Request correlation UUID.

Upstream calls made (storefront JSON API calls including re-requested refusals, and document reads when a fallback was needed; transient retries included), decoded bytes delivered to the parser and elapsed milliseconds.

accounting.upstreamRequestsinteger

Always included.

≥ 0

accounting.responseBytesinteger

Always included.

≥ 0

accounting.durationMsinteger

Always included.

≥ 0

successboolean

True when usable public data is returned; inspect status and coverage for omissions.

statusenum

success, partial, failed or challenged. HTTP 200 can be partial.

one of: success, partial

sourceUrlstring

Canonical public storefront URL the response describes.

absolute HTTPS URL

fetchedAtstring

UTC retrieval timestamp.

Complete means every supported field was read; warnings name each cap or fallback.

coverage.sourceenum

Always included.

one of: public_page, public_api

coverage.completeboolean

Always included.

coverage.warningsenum[]

Always included.

product_idstring

TikTok Shop product ID (15-22 digits); provide either product_id or url.

seller_idstring

Seller (shop) ID of the product.

Always included.

up to 20 items

related_videos.item_idstring

Always included.

related_videos.heightinteger

Always included.

≥ 0

related_videos.widthinteger

Always included.

≥ 0

related_videos.durationinteger

Always included.

≥ 0

related_videos.author_idstring

Always included.

related_videos.play_countstring

Always included.

related_videos.like_countstring

Always included.

related_videos.upload_timestring

Always included.

related_videos.expiration_timestringoptional

Optional.

related_videos.titlestring

Always included.

related_videos.cover_image_urlstringnullable

Always included.

related_videos.content_urlstringnullable

Always included.

related_videos.author_namestring

Always included.

related_videos.author_avatar_urlstringnullable

Always included.

related_videos.bc_ad_label_textstringoptional

Optional.

Always included.

up to 10 items

more_from_shop.product_idstring

Always included.

more_from_shop.titlestring

Always included.

more_from_shop.image.heightinteger

Always included.

≥ 0

more_from_shop.image.widthinteger

Always included.

≥ 0

more_from_shop.image.uristring

Always included.

more_from_shop.image.url_liststring[]

Always included.

more_from_shop.product_price_info.sku_idstringoptional

Optional.

more_from_shop.product_price_info.symbol_positionintegeroptional

Optional.

more_from_shop.product_price_info.show_currency_spacebooleanoptional

Optional.

more_from_shop.product_price_info.currency_show_modeintegeroptional

Optional.

more_from_shop.product_price_info.currency_namestring

Always included.

more_from_shop.product_price_info.currency_symbolstring

Always included.

more_from_shop.product_price_info.sale_price_decimalstring

Always included.

more_from_shop.product_price_info.origin_price_decimalstringoptional

Optional.

more_from_shop.product_price_info.sale_price_formatstring

Always included.

more_from_shop.product_price_info.origin_price_formatstringoptional

Optional.

more_from_shop.product_price_info.discount_formatstringoptional

Optional.

more_from_shop.product_price_info.discount_decimalstringoptional

Optional.

more_from_shop.product_price_info.reduce_price_formatstringoptional

Optional.

more_from_shop.product_price_info.single_product_price_formatstringoptional

Optional.

more_from_shop.product_price_info.single_product_price_decimalstringoptional

Optional.

more_from_shop.product_price_info.sale_price_integer_part_formatstringoptional

Optional.

more_from_shop.product_price_info.sale_price_decimal_part_formatstringoptional

Optional.

more_from_shop.product_price_info.decimal_point_symbolstringoptional

Optional.

more_from_shop.product_price_info.promotion_deduction_detailsobjectoptional

Optional.

more_from_shop.product_price_info.raw_origin_price_decimalstringoptional

Optional.

more_from_shop.product_price_info.raw_origin_price_formatstringoptional

Optional.

Always included.

more_from_shop.rate_info.scorenumber

Always included.

more_from_shop.rate_info.review_countstring | integer

Always included.

more_from_shop.sold_info.sold_countinteger

Always included.

≥ 0

Always included.

more_from_shop.seller_info.seller_idstring

Always included.

more_from_shop.seller_info.shop_namestringoptional

Optional.

more_from_shop.seller_info.shop_logo.heightinteger

Always included.

≥ 0

more_from_shop.seller_info.shop_logo.widthinteger

Always included.

≥ 0

more_from_shop.seller_info.shop_logo.uristring

Always included.

more_from_shop.seller_info.shop_logo.url_liststring[]

Always included.

more_from_shop.seo_url.updated_atstringnullable

Always included.

more_from_shop.seo_url.canonical_urlstring

Always included.

absolute HTTPS URL

more_from_shop.seo_url.slugstring

Always included.

more_from_shop.seo_url.typeinteger

Always included.

more_from_shop.seo_url.versioninteger

Always included.

Optional.

more_from_shop.brand_info.brand_namestring

Always included.

up to 30 items

you_may_like.product_idstring

Always included.

you_may_like.titlestring

Always included.

you_may_like.image.heightinteger

Always included.

≥ 0

you_may_like.image.widthinteger

Always included.

≥ 0

you_may_like.image.uristring

Always included.

you_may_like.image.url_liststring[]

Always included.

you_may_like.product_price_info.sku_idstringoptional

Optional.

you_may_like.product_price_info.symbol_positionintegeroptional

Optional.

you_may_like.product_price_info.show_currency_spacebooleanoptional

Optional.

you_may_like.product_price_info.currency_show_modeintegeroptional

Optional.

you_may_like.product_price_info.currency_namestring

Always included.

you_may_like.product_price_info.currency_symbolstring

Always included.

you_may_like.product_price_info.sale_price_decimalstring

Always included.

you_may_like.product_price_info.origin_price_decimalstringoptional

Optional.

you_may_like.product_price_info.sale_price_formatstring

Always included.

you_may_like.product_price_info.origin_price_formatstringoptional

Optional.

you_may_like.product_price_info.discount_formatstringoptional

Optional.

you_may_like.product_price_info.discount_decimalstringoptional

Optional.

you_may_like.product_price_info.reduce_price_formatstringoptional

Optional.

you_may_like.product_price_info.single_product_price_formatstringoptional

Optional.

you_may_like.product_price_info.single_product_price_decimalstringoptional

Optional.

you_may_like.product_price_info.sale_price_integer_part_formatstringoptional

Optional.

you_may_like.product_price_info.sale_price_decimal_part_formatstringoptional

Optional.

you_may_like.product_price_info.decimal_point_symbolstringoptional

Optional.

you_may_like.product_price_info.promotion_deduction_detailsobjectoptional

Optional.

you_may_like.product_price_info.raw_origin_price_decimalstringoptional

Optional.

you_may_like.product_price_info.raw_origin_price_formatstringoptional

Optional.

Always included.

you_may_like.rate_info.scorenumber

Always included.

you_may_like.rate_info.review_countstring | integer

Always included.

you_may_like.sold_info.sold_countinteger

Always included.

≥ 0

Always included.

you_may_like.seller_info.seller_idstring

Always included.

you_may_like.seller_info.shop_namestringoptional

Optional.

you_may_like.seller_info.shop_logo.heightinteger

Always included.

≥ 0

you_may_like.seller_info.shop_logo.widthinteger

Always included.

≥ 0

you_may_like.seller_info.shop_logo.uristring

Always included.

you_may_like.seller_info.shop_logo.url_liststring[]

Always included.

you_may_like.seo_url.updated_atstringnullable

Always included.

you_may_like.seo_url.canonical_urlstring

Always included.

absolute HTTPS URL

you_may_like.seo_url.slugstring

Always included.

you_may_like.seo_url.typeinteger

Always included.

you_may_like.seo_url.versioninteger

Always included.

Optional.

you_may_like.brand_info.brand_namestring

Always included.

HTTP 200 returns the success variant. Check status: partial means usable data with warnings, and failed or challenged requests carry a failure object described in Errors & responses.

Error codes

HTTP	failure.code	Meaning
400	`invalid_request`	Missing, duplicate, ambiguous or unsupported parameters, unsupported URL forms, regions, sorts or cursors.
401	`unauthorized`	Invalid API key.
404	`not_found`	Unknown or removed product, or a store the storefront does not serve.
429	`upstream_rate_limited`	TikTok Shop rate limited the request.
502	`upstream_challenged`	TikTok Shop answered its Security Check page, an HTTP 401/403, or kept refusing the call after its re-requests (status challenged).
502	`unsafe_redirect`	TikTok Shop redirected outside the requested product or store (for example to a regional storefront or the login page).
502	`unsupported_page`	Layout, identity or JSON-envelope checks failed, or an unexpected document type was served.
502	`response_too_large`	The upstream response exceeded 4 MiB.
502	`payload_too_complex`	The upstream JSON exceeded parsing limits.
502	`request_limit`	The upstream call budget was exhausted.
502	`upstream_error`	Network failure, an unexpected upstream status after one retry, or an unexpected feed code.
503	`busy`	All retrieval slots are occupied.
504	`timeout`	The 40-second deadline elapsed.

Code example

curl "https://api.scrapeatlas.com/v1/tiktok/product/related?product_id=1729000000000000001" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  "https://api.scrapeatlas.com/v1/tiktok/product/related?product_id=1729000000000000001",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data.status, data);

type Result = {
  status: "success" | "partial" | "failed" | "challenged";
  requestId: string;
  [field: string]: unknown;
};

const response = await fetch(
  "https://api.scrapeatlas.com/v1/tiktok/product/related?product_id=1729000000000000001",
  {
    headers: {
      "x-api-key": process.env.SCRAPEATLAS_API_KEY!
    }
  }
);

const data = (await response.json()) as Result;
if (data.status === "failed" || data.status === "challenged") {
  throw new Error(`TikTok Shop request failed: ${data.requestId}`);
}
console.log(data);

import requests

response = requests.get(
    "https://api.scrapeatlas.com/v1/tiktok/product/related",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={
        "product_id": "1729000000000000001"
    },
    timeout=60,
)
data = response.json()
print(data["status"], data)

package main

import (
	"encoding/json"
	"fmt"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.scrapeatlas.com/v1/tiktok/product/related?product_id=1729000000000000001", nil)
	req.Header.Set("x-api-key", "YOUR_API_KEY")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
	fmt.Println(data["status"], data)
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        var client = HttpClient.newHttpClient();
        var request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.scrapeatlas.com/v1/tiktok/product/related?product_id=1729000000000000001"))
            .GET()
            .header("x-api-key", "YOUR_API_KEY")
            .build();
        var response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

Use your sa_live_… customer key at https://api.scrapeatlas.com.

Responses

Successful result. Synthetic example validated against the runtime contract.

{
  "success": true,
  "product_id": "1729000000000000001",
  "seller_id": "7400000000000000001",
  "related_videos": [
    {
      "item_id": "7400000000000000101",
      "height": 1280,
      "width": 720,
      "duration": 39234,
      "author_id": "7100000000000000101",
      "play_count": "4700",
      "like_count": "310",
      "upload_time": "1771291969",
      "expiration_time": "1790235301",
      "title": "Example gummies review #example",
      "cover_image_url": "https://p16-common-sign.tiktokcdn-us.com/example/cover.jpeg",
      "content_url": "https://v16m-default.tiktokcdn-us.com/example/video/",
      "author_name": "Example Creator",
      "author_avatar_url": "https://p16-common-sign.tiktokcdn-us.com/example/avatar.webp",
      "bc_ad_label_text": "Creator earns commission"
    }
  ],
  "more_from_shop": [
    {
      "product_id": "1729000000000000001",
      "title": "Example Ashwagandha Gummy - Mixed Berry, Vegan, 60 Count",
      "image": {
        "height": 500,
        "width": 500,
        "uri": "tos-example-i-000/card-1729000000000000001",
        "url_list": [
          "https://p16.static.example.test/tos-example-i-000/card-1729000000000000001~tplv-crop-webp:500:500.webp?dr=1",
          "https://p19.static.example.test/tos-example-i-000/card-1729000000000000001~tplv-crop-webp:500:500.webp?dr=1"
        ]
      },
      "product_price_info": {
        "sku_id": "1729000000000000001",
        "currency_name": "USD",
        "currency_symbol": "$",
        "sale_price_decimal": "19.47",
        "origin_price_decimal": "24.70",
        "sale_price_format": "19.47",
        "origin_price_format": "24.70",
        "discount_format": "21%",
        "discount_decimal": "0.21",
        "reduce_price_format": "Saving $5.23",
        "single_product_price_format": "19.47",
        "single_product_price_decimal": "19.47",
        "sale_price_integer_part_format": "19",
        "sale_price_decimal_part_format": "47",
        "decimal_point_symbol": ".",
        "symbol_position": 1,
        "show_currency_space": false,
        "currency_show_mode": 1,
        "promotion_deduction_details": {
          "seller_subtotal_deduction": "5.23",
          "seller_subtotal_deduction_decimal": "5.23"
        }
      },
      "rate_info": {
        "score": 4.5,
        "review_count": "94625"
      },
      "sold_info": {
        "sold_count": 1301853
      },
      "seller_info": {
        "seller_id": "7400000000000000001",
        "shop_name": "Example Wellness",
        "shop_logo": {
          "height": 300,
          "width": 300,
          "uri": "tos-example-i-000/logo-1",
          "url_list": [
            "https://p16.static.example.test/tos-example-i-000/logo-1~tplv-crop-webp:300:300.webp?dr=1",
            "https://p19.static.example.test/tos-example-i-000/logo-1~tplv-crop-webp:300:300.webp?dr=1"
          ]
        }
      },
      "seo_url": {
        "updated_at": "1754035613102",
        "canonical_url": "https://shop.tiktok.com/us/pdp/example-ashwagandha-gummy-mixed-berry-vegan/1729000000000000001",
        "slug": "example-ashwagandha-gummy-mixed-berry-vegan",
        "type": 2,
        "version": 2
      },
      "brand_info": {
        "brand_name": "Example"
      }
    }
  ],
  "you_may_like": [
    {
      "product_id": "1729000000000000002",
      "title": "Example Apple Cider Vinegar Gummy - Zero Sugar",
      "image": {
        "height": 500,
        "width": 500,
        "uri": "tos-example-i-000/card-1729000000000000002",
        "url_list": [
          "https://p16.static.example.test/tos-example-i-000/card-1729000000000000002~tplv-crop-webp:500:500.webp?dr=1",
          "https://p19.static.example.test/tos-example-i-000/card-1729000000000000002~tplv-crop-webp:500:500.webp?dr=1"
        ]
      },
      "product_price_info": {
        "sku_id": "1729000000000000001",
        "currency_name": "USD",
        "currency_symbol": "$",
        "sale_price_decimal": "15.00",
        "sale_price_format": "15.00",
        "single_product_price_format": "15.00",
        "single_product_price_decimal": "15.00",
        "sale_price_integer_part_format": "15",
        "sale_price_decimal_part_format": "00",
        "decimal_point_symbol": ".",
        "symbol_position": 1,
        "show_currency_space": false,
        "currency_show_mode": 1,
        "promotion_deduction_details": {}
      },
      "rate_info": {
        "score": 4.6,
        "review_count": "51002"
      },
      "sold_info": {
        "sold_count": 812333
      },
      "seller_info": {
        "seller_id": "7400000000000000001",
        "shop_name": "Example Wellness",
        "shop_logo": {
          "height": 300,
          "width": 300,
          "uri": "tos-example-i-000/logo-1",
          "url_list": [
            "https://p16.static.example.test/tos-example-i-000/logo-1~tplv-crop-webp:300:300.webp?dr=1",
            "https://p19.static.example.test/tos-example-i-000/logo-1~tplv-crop-webp:300:300.webp?dr=1"
          ]
        }
      },
      "seo_url": {
        "updated_at": "1754035613102",
        "canonical_url": "https://shop.tiktok.com/us/pdp/example-apple-cider-vinegar-gummy-zero-sugar/1729000000000000002",
        "slug": "example-apple-cider-vinegar-gummy-zero-sugar",
        "type": 2,
        "version": 2
      },
      "brand_info": {
        "brand_name": "Example"
      }
    }
  ],
  "status": "success",
  "requestId": "11111111-1111-4111-8111-111111111111",
  "sourceUrl": "https://shop.tiktok.com/us/pdp/1729000000000000001",
  "fetchedAt": "2026-09-12T12:00:00.000Z",
  "coverage": {
    "source": "public_api",
    "complete": true,
    "warnings": []
  },
  "accounting": {
    "upstreamRequests": 2,
    "responseBytes": 699180,
    "durationMs": 4800
  }
}

Missing, duplicate, ambiguous or unsupported parameters, unsupported URL forms, regions, sorts or cursors.

{
  "requestId": "9d2f1c0a-6b1e-4c7d-9a8e-2f3b4c5d6e7f",
  "accounting": {
    "upstreamRequests": 0,
    "responseBytes": 0,
    "durationMs": 0
  },
  "success": false,
  "status": "failed",
  "failure": {
    "code": "invalid_request",
    "message": "Invalid request: missing, duplicate, unsupported or malformed parameters."
  }
}