/v1/tiktok/product

GET

Product Details

Get details for a TikTok Shop product. US products only.

Credit cost	Default: 1 credit How charges are determined Cost is decided per call, not per endpoint: the same operation can cost different amounts depending on what it returns. A call that fails costs 0 credits. A result served from cache costs 0 credits. `default` is the cost when no rule matches. Rules are evaluated in order and the first whose conditions all hold wins. A `when` condition is one of: `param` (the request parameter is true), `outcome` (the classifier's outcome), `empty` / `nonEmpty` (a response field is empty and absent, or a non-empty array or string), `flag` (a response field is exactly true). A cost of `{ perStartedMinute: n, of: [fields] }` is n x max(1, ceil(seconds / 60)), so even a short result bills at least one minute.
Cache support	Not specified in the published contract.
Pagination	No explicit pagination metadata in the published contract. Consult the parameters and response fields below.

Parameters

Name	Location / required	Schema
`url` The URL of the product to get details for.	query / required	`string`
`region` Product region. Only US is reliable; non-US requests may return bad_request or missing product data.	query / optional	`string`

Request examples

Replace placeholder values and supply your own API key. For operations with a request body, populate the body using the schema above.

cURL

curl --request GET 'https://api.fetchproof.com/v1/tiktok/product?url=YOUR_URL' \
  --header 'x-api-key: YOUR_API_KEY'

JavaScript

const response = await fetch("https://api.fetchproof.com/v1/tiktok/product?url=YOUR_URL", {
  method: 'GET',
  headers: { 'x-api-key': process.env.FETCHPROOF_API_KEY }
});
console.log(await response.text());

Python

import os
import requests

response = requests.get("https://api.fetchproof.com/v1/tiktok/product?url=YOUR_URL",
    headers={"x-api-key": os.environ["FETCHPROOF_API_KEY"]})
print(response.text)

Responses

200Success. Envelope: success / credits_remaining / credits_charged.

application/json

object

successrequired

boolean

credits_remainingrequired

integer

credits_chargedrequired

integer

categoriesrequired

array

Array items

object

category_idrequired

string

levelrequired

integer

is_leafrequired

boolean

parent_idrequired

string

category_namerequired

string

name_keyrequired

string

sale_regionrequired

string

error_coderequired

integer

error_messagerequired

string

product_inforequired

object

product_idrequired

string

statusrequired

integer

sellerrequired

object

seller_idrequired

string

namerequired

string

avatarrequired

object

heightrequired

integer

widthrequired

integer

urirequired

string

url_listrequired

array

Array items

string

product_countrequired

integer

seller_locationrequired

string

tiktok_idrequired

string

tiktok_urlrequired

string

product_baserequired

object

titlerequired

string

desc_videorequired

object

idrequired

string

durationrequired

number

post_urlrequired

string

media_typerequired

string

video_infosrequired

array

Array items

object

main_urlrequired

string

backup_urlrequired

string

url_expirerequired

integer

widthrequired

integer

heightrequired

integer

file_hashrequired

string

formatrequired

string

sizerequired

integer

bitraterequired

integer

video_qualityrequired

string

imagesrequired

array

Array items

object

heightrequired

integer

widthrequired

integer

thumb_urirequired

string

thumb_url_listrequired

array

Array items

string

urirequired

string

url_listrequired

array

Array items

string

sold_countrequired

integer

pricerequired

object

original_pricerequired

string

real_pricerequired

string

discountrequired

string

need_iconrequired

boolean

is_interval_pricerequired

boolean

show_hot_zonerequired

boolean

min_sku_pricerequired

string

max_sku_pricerequired

string

currencyrequired

string

min_sku_original_pricerequired

string

panel_schemarequired

string

currency_symbolrequired

string

symbol_positionrequired

integer

da_inforequired

string

sale_propsrequired

array

Array items

object

prop_idrequired

string

prop_namerequired

string

has_imagerequired

boolean

sale_prop_valuesrequired

array

Array items

object

prop_value_idrequired

string

prop_valuerequired

string

imagerequired

object

heightrequired

integer

widthrequired

integer

thumb_urirequired

string

thumb_url_listrequired

array

Array items

string

urirequired

string

url_listrequired

array

Array items

string

skusrequired

array

Array items

object

sku_idrequired

string

sku_namerequired

null

gtinrequired

null

sku_sale_propsrequired

array

Array items

object

prop_idrequired

string

prop_namerequired

string

prop_value_idrequired

string

prop_valuerequired

string

sale_prop_value_idsrequired

string

stockrequired

integer

purchase_limitrequired

integer

pricerequired

object

real_pricerequired

object

price_strrequired

string

price_valrequired

string

currencyrequired

string

original_pricerequired

string

original_pricerequired

string

discountrequired

string

original_price_valuerequired

string

need_iconrequired

boolean

add_to_cart_buttonrequired

object

statusrequired

integer

warehouse_idrequired

string

quantity_propertyrequired

object

default_add_cart_quantityrequired

integer

quantity_minus_support_editrequired

boolean

buy_buttonrequired

object

descrequired

string

default_descrequired

string

minimum_buy_quantityrequired

integer

promotion_limit_quantityrequired

integer

deduction_textrequired

string

statusrequired

integer

pdp_button_area_idrequired

string

da_inforequired

string

product_detail_reviewrequired

object

product_ratingrequired

number

review_countrequired

integer

review_itemsrequired

array

Array items

object

reviewrequired

object

review_idrequired

string

ratingrequired

integer

display_textrequired

string

review_timestamprequired

string

has_origin_textrequired

boolean

display_review_textrequired

array

Array items

object

text_typerequired

integer

plain_textrequired

string

review_timestamp_fmtrequired

string

main_review_titlerequired

string

sku_idrequired

string

sku_specificationrequired

string

review_userrequired

object

namerequired

string

avatarrequired

object

url_listrequired

array

Array items

string

linkrequired

string

is_ownerrequired

boolean

is_anonymousrequired

boolean

review_source_typerequired

integer

review_source_namerequired

string

linkrequired

string

is_updatedrequired

boolean

third_party_popup_titlerequired

string

third_party_popup_contentrequired

string

third_party_popup_button_textrequired

string

review_count_strrequired

string

review_count_str_v2required

string

seller_idrequired

string

shop_inforequired

object

seller_idrequired

string

sold_countrequired

integer

on_sell_product_countrequired

integer

review_countrequired

integer

global_seller_idrequired

string

global_sold_countrequired

string

followers_countrequired

string

video_countrequired

string

enable_followrequired

boolean

shop_namerequired

string

shop_logorequired

object

heightrequired

integer

widthrequired

integer

urirequired

string

url_listrequired

array

Array items

string

shop_ratingrequired

string

shop_linkrequired

string

backgroundrequired

object

is_defaultrequired

boolean

imagerequired

object

heightrequired

integer

widthrequired

integer

urirequired

string

url_listrequired

array

Array items

string

shop_background_typerequired

integer

format_sold_countrequired

string

regionrequired

string

display_on_sell_product_countrequired

string

format_global_sold_countrequired

string

format_followers_countrequired

string

format_video_countrequired

string

store_sub_scorerequired

array

Array items

object

scorerequired

number

typerequired

integer

score_percentagerequired

string

high_light_tagoptional

integer

platform_rate_typerequired

integer

worst_ratingrequired

string

best_ratingrequired

string

creator_namerequired

string

shop_identity_labelrequired

object

label_typerequired

integer

identity_label_textrequired

string

identity_logo_lightrequired

object

heightrequired

integer

widthrequired

integer

ratiorequired

integer

minetyperequired

string

urirequired

string

url_listrequired

array

Array items

string

descrequired

string

shop_performancerequired

array

Array items

object

score_percentilerequired

integer

typerequired

integer

related_videosrequired

array

Array items

object

item_idrequired

string

heightrequired

integer

widthrequired

integer

durationrequired

integer

author_idrequired

string

play_countrequired

integer

like_countrequired

integer

upload_timerequired

string

expiration_timerequired

string

titlerequired

string

cover_image_urlrequired

string

content_urlrequired

string

author_namerequired

string

author_avatar_urlrequired

string

bc_ad_label_textrequired

string

urlrequired

string

author_urlrequired

string

401Invalid or missing x-api-key

402No credits remaining

403Upstream denied (age gate, audience controls)

404Resource or endpoint not found

429Rate limited