API reference

TikTok Shop Product API

One TikTok Shop product: title, prices, images, sold count, rating and review count, categories, seller and SKUs. SKU-level stock is included where available; it is a source-reported value, not a guaranteed real-time inventory or checkout confirmation.

Read as Markdown Use with an AI agent

Endpoint

GET/v1/tiktokshop/productlive · proven2 credits

Try in Playground

Parameters

Query parameters

Name	Required	Description	Example
`url`	yes	Product URL	`https://www.tiktok.com/shop/pdp/goli-ashwagandha-gummies-with-vitamin-d-ksm-66-vegan-non-gmo/1729587769570529799`
`region`	no	Storefront region (US is the reliable one today)	`US`
`dry_run`	no	Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution.	`1`

Examples

Make the request

curl

curl "https://www.monocrawl.com/v1/tiktokshop/product?url=https%3A%2F%2Fwww.tiktok.com%2Fshop%2Fpdp%2Fgoli-ashwagandha-gummies-with-vitamin-d-ksm-66-vegan-non-gmo%2F1729587769570529799" \
  -H "x-api-key: mn_your_key_here"

TypeScript

typescript

const key = process.env.MONOCRAWL_API_KEY;
if (!key) throw new Error('Set MONOCRAWL_API_KEY on your server.');
const res = await fetch(
  "https://www.monocrawl.com/v1/tiktokshop/product?url=https%3A%2F%2Fwww.tiktok.com%2Fshop%2Fpdp%2Fgoli-ashwagandha-gummies-with-vitamin-d-ksm-66-vegan-non-gmo%2F1729587769570529799",
  { headers: { "x-api-key": key } },
);
const body = await res.json();

if (!body.success) {
  // one error shape for every endpoint — see /docs/errors
  throw new Error(`${body.error.type}: ${body.error.message}`);
}

console.log(body.data, "credits left:", body.credits_remaining);

Python

python

import os
import requests

res = requests.get(
    "https://www.monocrawl.com/v1/tiktokshop/product?url=https%3A%2F%2Fwww.tiktok.com%2Fshop%2Fpdp%2Fgoli-ashwagandha-gummies-with-vitamin-d-ksm-66-vegan-non-gmo%2F1729587769570529799",
    headers={"x-api-key": os.environ["MONOCRAWL_API_KEY"]},
    timeout=60,
)
body = res.json()

if not body["success"]:
    # one error shape for every endpoint — see /docs/errors
    raise RuntimeError(f"{body['error']['type']}: {body['error']['message']}")

print(body["data"], "credits left:", body["credits_remaining"])

Response

Response fields and example

This example is illustrative, not a captured live response. Variable-cost operations may settle a charge different from the list price below. A successful response puts the platform payload in data and reports the exact credits used, remaining balance, request id and cache status beside it.

200 · application/json

{
  "success": true,
  "platform": "tiktokshop",
  "endpoint": "/v1/tiktokshop/product",
  "data": {
    "categories": [
      "example"
    ],
    "id": "example",
    "images": [],
    "platform": "example",
    "price": {
      "currency": "example",
      "currency_symbol": "example",
      "da_info": "example",
      "discount": "example",
      "is_interval_price": false,
      "max_sku_price": "example",
      "min_sku_original_price": "example",
      "min_sku_price": "example",
      "need_icon": false,
      "original_price": "example",
      "panel_schema": "example",
      "real_price": "example",
      "show_hot_zone": false,
      "symbol_position": 0
    },
    "rating": 0,
    "review_count": 0,
    "sale_region": "example",
    "seller": {
      "id": "example",
      "location": "example",
      "name": "example",
      "product_count": 0,
      "tiktok_url": "https://example.com/example"
    },
    "shop": {
      "id": "example",
      "products": 0,
      "review_count": 0,
      "sold_count": 0
    },
    "skus": [
      {
        "id": "example",
        "price": {
          "discount": "example",
          "original_price": "example",
          "original_price_value": "example",
          "real_price": {}
        },
        "stock": 0
      }
    ],
    "sold_count": 0,
    "title": "example"
  },
  "credits_used": 2,
  "credits_remaining": 99,
  "request_id": "req_…",
  "cached": false
}

The example is illustrative and shows a documented subset of data. The fields below are optional across supported sources; nullable fields can also be absent. Preserve unknown values and accept additional fields.

Schema basis: observed response shapes, not an exhaustive field specification. See schema coverage and validation limits.

Download the data JSON Schema. Validate response.data, not the whole envelope. A valid shape does not establish that every field or source record was returned.

Field inside data	Type	Meaning
`categories`	`array \| null`	Optional categories supplied by this operation. Null means unknown.
`id`	`string \| null`	Source identifier. Preserve the supplied type and exact value.
`images`	`array \| null`	Source array was empty in the reviewed captures; item fields remain unspecified.
`platform`	`string \| null`	Optional platform supplied by this operation. Null means unknown.
`price`	`object \| null`	Source price. Currency, taxes and availability depend on the listing.
`price.currency`	`string \| null`	Optional currency supplied by this operation. Null means unknown.
`price.currency_symbol`	`string \| null`	Optional currency symbol supplied by this operation. Null means unknown.
`price.da_info`	`string \| null`	Optional da info supplied by this operation. Null means unknown.
`price.discount`	`string \| null`	Optional discount supplied by this operation. Null means unknown.
`price.is_interval_price`	`boolean \| null`	Optional is interval price supplied by this operation. Null means unknown.
`price.max_sku_price`	`number \| string \| null`	Decimal source amounts are normalized to JSON numbers in the accompanying currency. Non-numeric source labels may remain text; null is unknown.
`price.min_sku_original_price`	`number \| string \| null`	Decimal source amounts are normalized to JSON numbers in the accompanying currency. Non-numeric source labels may remain text; null is unknown.
`price.min_sku_price`	`number \| string \| null`	Decimal source amounts are normalized to JSON numbers in the accompanying currency. Non-numeric source labels may remain text; null is unknown.
`price.need_icon`	`boolean \| null`	Optional need icon supplied by this operation. Null means unknown.
`price.original_price`	`string \| null`	Optional original price supplied by this operation. Null means unknown.
`price.panel_schema`	`string \| null`	Optional panel schema supplied by this operation. Null means unknown.
`price.real_price`	`string \| null`	Optional real price supplied by this operation. Null means unknown.
`price.show_hot_zone`	`boolean \| null`	Optional show hot zone supplied by this operation. Null means unknown.
`price.symbol_position`	`number \| null`	Optional symbol position supplied by this operation. Null means unknown.
`price.max_sku_original_price`	`number \| string \| null`	Decimal source amounts are normalized to JSON numbers in the accompanying currency. Non-numeric source labels may remain text; null is unknown.
`rating`	`number \| null`	Source rating; read its accompanying scale and vote count.
`review_count`	`number \| null`	Optional review count supplied by this operation. Null means unknown.
`sale_region`	`string \| null`	Optional sale region supplied by this operation. Null means unknown.
`seller`	`object \| null`	Optional seller supplied by this operation. Null means unknown.
`seller.id`	`string \| null`	Source identifier. Preserve the supplied type and exact value.
`seller.location`	`string \| null`	Optional location supplied by this operation. Null means unknown.
`seller.name`	`string \| null`	Optional name supplied by this operation. Null means unknown.
`seller.product_count`	`number \| null`	Optional product count supplied by this operation. Null means unknown.
`seller.tiktok_url`	`string \| null`	Optional tiktok url supplied by this operation. Null means unknown.
`shop`	`object \| null`	Optional shop supplied by this operation. Null means unknown.
`shop.id`	`string \| null`	Source identifier. Preserve the supplied type and exact value.
`shop.products`	`number \| null`	Optional products supplied by this operation. Null means unknown.
`shop.review_count`	`number \| null`	Optional review count supplied by this operation. Null means unknown.
`shop.sold_count`	`number \| null`	Optional sold count supplied by this operation. Null means unknown.
`skus`	`array \| null`	Optional skus supplied by this operation. Null means unknown.
`skus[].id`	`string \| null`	Source identifier. Preserve the supplied type and exact value.
`skus[].price`	`object \| null`	Source price. Currency, taxes and availability depend on the listing.
`skus[].price.discount`	`string \| null`	Optional discount supplied by this operation. Null means unknown.
`skus[].price.original_price`	`string \| null`	Optional original price supplied by this operation. Null means unknown.
`skus[].price.original_price_value`	`string \| null`	Optional original price value supplied by this operation. Null means unknown.
`skus[].price.real_price`	`object \| null`	Optional real price supplied by this operation. Null means unknown.
`skus[].stock`	`number \| null`	Optional stock supplied by this operation. Null means unknown.
`sold_count`	`number \| null`	Optional sold count supplied by this operation. Null means unknown.
`title`	`string \| null`	Source title when supplied.

Optional fields reviewed from preserved successful responses. Additive fields and source variations remain allowed; validate the fields your workflow requires.

The example is invented and illustrates types only; zero and empty values are not claims about a real result.

Failures use the typed error envelope. A confirmed uncharged or refunded failure reports zero; a pending reconciliation can report an unknown charge. Read credits_used and error.details.billing_status, and keep request_id for recovery. Response contract · Error reference

TikTok Shop Product API

Query parameters

Make the request

Response fields and example

More TikTok Shop reference

First call in under a minute