StatusSupportGet API keyDashboard
TikTok ShopSearch

TikTok Shop

TikTok Shop Search API

Use with AI

Searches TikTok Shop's US products by keyword and returns them in TikTok Shop's relevance order, a page at a time. Each has its link, title, image, price with the price before discount and the highest variant price, units sold, rating and review count, brand, free shipping, and the shop selling it with its storefront link and verified badge.

GET /v1/tiktokshop/search_products

Try it

Example

cURL
curl 'https://socialtap.dev/v1/tiktokshop/search_products?query=ashwagandha' \
  -H "x-api-key: $SOCIALTAP_API_KEY"
TypeScript SDK
import { SocialTap } from "socialtap";

const client = new SocialTap(); // apiKey defaults to process.env.SOCIALTAP_API_KEY

const res = await client.tiktokshop.searchProducts.list({ query: "ashwagandha" });
console.log(res.data);
console.log(res.credits.charged, res.meta.request_id);
Node.js (fetch)
const params = new URLSearchParams({
  query: "ashwagandha",
});
const res = await fetch(`https://socialtap.dev/v1/tiktokshop/search_products?${params}`, {
  headers: { "x-api-key": process.env.SOCIALTAP_API_KEY ?? "" },
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
const { data, page, meta } = body;
console.log(data, meta.credits_charged);
Python (requests)
import os

import requests

res = requests.get(
    "https://socialtap.dev/v1/tiktokshop/search_products",
    params={"query": "ashwagandha"},
    headers={"x-api-key": os.environ["SOCIALTAP_API_KEY"]},
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
data, page, meta = body["data"], body["page"], body["meta"]
print(data, meta["credits_charged"])
Go (net/http)
package main

import (
	"encoding/json"
	"fmt"
	"log"
	"net/http"
	"net/url"
	"os"
)

func main() {
	q := url.Values{}
	q.Set("query", "ashwagandha")
	req, err := http.NewRequest("GET", "https://socialtap.dev/v1/tiktokshop/search_products?"+q.Encode(), nil)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("x-api-key", os.Getenv("SOCIALTAP_API_KEY"))
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	defer res.Body.Close()
	var body struct {
		Data  json.RawMessage `json:"data"`
		Page  json.RawMessage `json:"page"`
		Meta  map[string]any  `json:"meta"`
		Error *struct {
			Code    string `json:"code"`
			Message string `json:"message"`
		} `json:"error"`
	}
	if err := json.NewDecoder(res.Body).Decode(&body); err != nil {
		log.Fatal(err)
	}
	if body.Error != nil {
		log.Fatalf("%s: %s", body.Error.Code, body.Error.Message)
	}
	fmt.Println(string(body.Data), body.Meta["credits_charged"])
}
PHP
<?php

$query = http_build_query([
    'query' => 'ashwagandha',
]);
$ch = curl_init('https://socialtap.dev/v1/tiktokshop/search_products?' . $query);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['x-api-key: ' . getenv('SOCIALTAP_API_KEY')],
]);
$body = json_decode(curl_exec($ch), true);
if (curl_getinfo($ch, CURLINFO_RESPONSE_CODE) >= 400) {
    throw new RuntimeException($body['error']['code'] . ': ' . $body['error']['message']);
}
print_r($body['data']);
echo $body['meta']['credits_charged'], PHP_EOL;
Ruby
require "json"
require "net/http"

uri = URI("https://socialtap.dev/v1/tiktokshop/search_products")
uri.query = URI.encode_www_form('query' => 'ashwagandha')
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = ENV.fetch("SOCIALTAP_API_KEY")
res = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https") { |http| http.request(req) }
body = JSON.parse(res.body)
raise "#{body["error"]["code"]}: #{body["error"]["message"]}" unless res.is_a?(Net::HTTPSuccess)
pp body["data"]
puts body["meta"]["credits_charged"]
Java
import java.net.URI;
import java.net.URLEncoder;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.charset.StandardCharsets;

public class Main {
    public static void main(String[] args) throws Exception {
        String query = "query=" + encode("ashwagandha");
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://socialtap.dev/v1/tiktokshop/search_products?" + query))
            .header("x-api-key", System.getenv("SOCIALTAP_API_KEY"))
            .GET()
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        // An error is {"error": {"code", "message", ...}}; success is {data, meta}, meta.credits_charged its price.
        if (response.statusCode() >= 400) throw new RuntimeException(response.body());
        System.out.println(response.body());
    }

    static String encode(String value) {
        return URLEncoder.encode(value, StandardCharsets.UTF_8);
    }
}
.NET
using System.Text.Json;

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("x-api-key", Environment.GetEnvironmentVariable("SOCIALTAP_API_KEY"));

var query = string.Join("&",
    "query=" + Uri.EscapeDataString("ashwagandha"));
var res = await http.GetAsync("https://socialtap.dev/v1/tiktokshop/search_products?" + query);
using var body = JsonDocument.Parse(await res.Content.ReadAsStringAsync());
if (!res.IsSuccessStatusCode)
{
    var error = body.RootElement.GetProperty("error");
    throw new Exception($"{error.GetProperty("code")}: {error.GetProperty("message")}");
}
Console.WriteLine(body.RootElement.GetProperty("data"));
Console.WriteLine(body.RootElement.GetProperty("meta").GetProperty("credits_charged"));
Rust
// Cargo.toml: reqwest = { version = "0.12", features = ["blocking", "json"] }, serde_json = "1"
use std::env;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let res = reqwest::blocking::Client::new()
        .get("https://socialtap.dev/v1/tiktokshop/search_products")
        .query(&[("query", "ashwagandha")])
        .header("x-api-key", env::var("SOCIALTAP_API_KEY")?)
        .send()?;
    let ok = res.status().is_success();
    let body: serde_json::Value = res.json()?;
    if !ok {
        return Err(format!("{}: {}", body["error"]["code"], body["error"]["message"]).into());
    }
    println!("{} {}", body["data"], body["meta"]["credits_charged"]);
    Ok(())
}
200 OK
{
  "data": [
    {
      "approximate_fields": [
        "platform_specific.tiktokshop.rating"
      ],
      "attributes": [],
      "availability": null,
      "category": null,
      "category_id": null,
      "condition": null,
      "condition_label": null,
      "country_code": "US",
      "currency": "USD",
      "description": null,
      "id": "1729488739201226090",
      "max_price": 32.49,
      "media": [
        {
          "alt_text": null,
          "duration_ms": null,
          "expires_at": null,
          "height": 2560,
          "thumbnail_url": null,
          "type": "image",
          "url": "https://p16-oec-general-useast8.ttcdn-us.com/tos-useast8-i-rt0ujvrtvp-tx2/91d95713b57c4b4d950fa875926735cd~tplv-fhlh96nyum-crop-webp:2560:2560.webp?dr=12190&t=555f072d&ps=933b5bde&shp=8dbd94bf&shcp=a6e80448&idc=useast5&from=2378011839",
          "width": 2560
        }
      ],
      "original_price": null,
      "platform": "tiktokshop",
      "platform_specific": {
        "tiktokshop": {
          "brand": "youtheory",
          "delivery_max_days": null,
          "delivery_min_days": null,
          "metrics": {
            "rating_distribution": null,
            "review_count": 37,
            "sold_count": 229,
            "stock_count": null
          },
          "rating": 4.6,
          "shop": null,
          "variants": []
        }
      },
      "price": 32.49,
      "seller": {
        "avatar_url": "https://p16-oec-general-useast5.ttcdn-us.com/tos-useast5-i-omjb5zjo8w-tx/cc8c449d5a9c4cc59d3dfafb39a92a97~tplv-fhlh96nyum-resize-png:300:300.png?dr=12184&t=555f072d&ps=933b5bde&shp=905da467&shcp=d9d491bf&idc=useast5&from=2422056039",
        "display_name": "youtheory",
        "id": "7496211336786708842",
        "is_verified": true,
        "url": "https://shop.tiktok.com/us/store/youtheory/7496211336786708842",
        "username": null
      },
      "shipping": {
        "fee": 0,
        "is_offered": true
      },
      "thumbnail_url": "https://p16-oec-general-useast8.ttcdn-us.com/tos-useast8-i-rt0ujvrtvp-tx2/91d95713b57c4b4d950fa875926735cd~tplv-fhlh96nyum-crop-webp:2560:2560.webp?dr=12190&t=555f072d&ps=933b5bde&shp=8dbd94bf&shcp=a6e80448&idc=useast5&from=2378011839",
      "title": "YOUTHEORY Ashwagandha Supplement Capsules 60 Count - KSM-66 Ashwagandha + GABA, Organic Ginger, Adaptogen Stress Relief, Clinically Supported, Dietary Botanical, GMP-Certified Vegetarian Capsules",
      "type": "product",
      "unknown_fields": [
        "attributes",
        "platform_specific.tiktokshop.variants"
      ],
      "url": "https://shop.tiktok.com/us/pdp/1729488739201226090"
    },
    {
      "approximate_fields": [
        "platform_specific.tiktokshop.rating"
      ],
      "attributes": [],
      "availability": null,
      "category": null,
      "category_id": null,
      "condition": null,
      "condition_label": null,
      "country_code": "US",
      "currency": "USD",
      "description": null,
      "id": "1732757061224141233",
      "max_price": 19.99,
      "media": [
        {
          "alt_text": null,
          "duration_ms": null,
          "expires_at": null,
          "height": 1000,
          "thumbnail_url": null,
          "type": "image",
          "url": "https://p16-oec-general-useast5.ttcdn-us.com/tos-useast5-i-omjb5zjo8w-tx/b7e7126391b2411c860c7c38a7a7fc7a~tplv-fhlh96nyum-crop-webp:1000:1000.webp?dr=12190&t=555f072d&ps=933b5bde&shp=8dbd94bf&shcp=a6e80448&idc=useast5&from=2378011839",
          "width": 1000
        }
      ],
      "original_price": null,
      "platform": "tiktokshop",
      "platform_specific": {
        "tiktokshop": {
          "brand": null,
          "delivery_max_days": null,
          "delivery_min_days": null,
          "metrics": {
            "rating_distribution": null,
            "review_count": 1,
            "sold_count": 38,
            "stock_count": null
          },
          "rating": 4,
          "shop": null,
          "variants": []
        }
      },
      "price": 11.99,
      "seller": {
        "avatar_url": "https://p16-oec-general-useast5.ttcdn-us.com/tos-useast5-i-omjb5zjo8w-tx/26b624d17d3b475ca8f44b668af47c9e~tplv-fhlh96nyum-resize-png:300:300.png?dr=12184&t=555f072d&ps=933b5bde&shp=905da467&shcp=d9d491bf&idc=useast5&from=2422056039",
        "display_name": "Robesan Shop",
        "id": "7496000556813355441",
        "is_verified": false,
        "url": "https://shop.tiktok.com/us/store/robesan-shop/7496000556813355441",
        "username": null
      },
      "shipping": {
        "fee": 0,
        "is_offered": true
      },
      "thumbnail_url": "https://p16-oec-general-useast5.ttcdn-us.com/tos-useast5-i-omjb5zjo8w-tx/b7e7126391b2411c860c7c38a7a7fc7a~tplv-fhlh96nyum-crop-webp:1000:1000.webp?dr=12190&t=555f072d&ps=933b5bde&shp=8dbd94bf&shcp=a6e80448&idc=useast5&from=2378011839",
      "title": "Bunkell Ashwagandha Health Supplements,Supports endurance and performance,60 Capsules",
      "type": "product",
      "unknown_fields": [
        "attributes",
        "platform_specific.tiktokshop.variants"
      ],
      "url": "https://shop.tiktok.com/us/pdp/1732757061224141233"
    },
    {
      "approximate_fields": [
        "platform_specific.tiktokshop.rating"
      ],
      "attributes": [],
      "availability": null,
      "category": null,
      "category_id": null,
      "condition": null,
      "condition_label": null,
      "country_code": "US",
      "currency": "USD",
      "description": null,
      "id": "1730657812285330093",
      "max_price": 38.94,
      "media": [
        {
          "alt_text": null,
          "duration_ms": null,
          "expires_at": null,
          "height": 1500,
          "thumbnail_url": null,
          "type": "image",
          "url": "https://p16-oec-general-useast5.ttcdn-us.com/tos-useast5-i-omjb5zjo8w-tx/f72f80945ed94f2399d67c0767586060~tplv-fhlh96nyum-crop-webp:1500:1500.webp?dr=12190&t=555f072d&ps=933b5bde&shp=8dbd94bf&shcp=a6e80448&idc=useast5&from=2378011839",
          "width": 1500
        }
      ],
      "original_price": 26.95,
      "platform": "tiktokshop",
      "platform_specific": {
        "tiktokshop": {
          "brand": "Micro Ingredients",
          "delivery_max_days": null,
          "delivery_min_days": null,
          "metrics": {
            "rating_distribution": null,
            "review_count": 2857,
            "sold_count": 28428,
            "stock_count": null
          },
          "rating": 4.8,
          "shop": null,
          "variants": []
        }
      },
      "price": 19.95,
      "seller": {
        "avatar_url": "https://p16-oec-general-useast5.ttcdn-us.com/tos-useast5-i-omjb5zjo8w-tx/5959296c496c421791fa78fa45cfd017~tplv-fhlh96nyum-resize-png:300:300.png?dr=12184&t=555f072d&ps=933b5bde&shp=905da467&shcp=d9d491bf&idc=useast5&from=2422056039",
        "display_name": "Micro Ingredients",
        "id": "7494949083499694765",
        "is_verified": true,
        "url": "https://shop.tiktok.com/us/store/micro-ingredients/7494949083499694765",
        "username": null
      },
      "shipping": {
        "fee": 0,
        "is_offered": true
      },
      "thumbnail_url": "https://p16-oec-general-useast5.ttcdn-us.com/tos-useast5-i-omjb5zjo8w-tx/f72f80945ed94f2399d67c0767586060~tplv-fhlh96nyum-crop-webp:1500:1500.webp?dr=12190&t=555f072d&ps=933b5bde&shp=8dbd94bf&shcp=a6e80448&idc=useast5&from=2378011839",
      "title": "Micro Ingredients Ashwagandha + Black Pepper Extract with MCT Oil Softgels",
      "type": "product",
      "unknown_fields": [
        "attributes",
        "platform_specific.tiktokshop.variants"
      ],
      "url": "https://shop.tiktok.com/us/pdp/1730657812285330093"
    }
  ],
  "page": {
    "has_more": true,
    "next_cursor": "c1.EXAMPLE_CURSOR",
    "next_cursor_expires_at": "2026-10-26T12:00:00Z",
    "end_reason": null
  },
  "meta": {
    "request_id": "req_3f9c2a7d1e8b4c6a9f0e2d4b6a8c0e1f",
    "platform": "tiktokshop",
    "source": "api",
    "is_cached": false,
    "credits_charged": 1,
    "latency_ms": 882,
    "fetched_at": "2026-10-25T12:00:00Z",
    "input": null,
    "credits_remaining": 9999,
    "client_request_id": null,
    "warnings": []
  }
}

Long arrays and strings are shortened for display; real responses are complete.

Authorizations

x-api-keystringheaderrequired

Your API key. Authentication

Query parameters

querystringrequiredmax 200 chars

Keywords, matched by TikTok Shop's product search against product titles, brands and shops (case-insensitive).

Exampleashwagandha

limitintegermin 1max 30

Items per page, 1 to the endpoint's page size (its default and maximum; larger values are reduced to it). Omit it: every page costs the same, so a smaller limit means more pages to pay for.

Example30

cursorstring

page.next_cursor from the previous response. Send the same other parameters; omit to start from the first page.

Unknown parameters are rejected with a suggestion, never ignored (Requests). limit and cursor page through the list: see Pagination.

Parameters every endpoint accepts
max_ageintegermin 0

Accept a cached response up to this many seconds old. Cache hits cost 0 credits. Omit to always fetch fresh. The Cache-Control: max-age=N request header is equivalent; max_age wins when both are sent.

fieldsstring

Return only these fields of each item: comma-separated paths in the schema's notation (id,text,metrics.view_count,segments[].text; a parent path keeps the whole object). Unknown paths are rejected. Applied after the cache, so it changes neither the price nor cache hits; page and meta are always returned whole.

Response

application/json

200

{data, page, meta}. data is an array of up to 30 product objects, TikTok Shop's relevance order; page says how to get the next page; meta describes the request (meta). Fields only TikTok Shop has are under platform_specific.tiktokshop.

platformstring

Platform ID (tiktokshop, facebook, …).

idstring

Platform-native product or listing ID (string).

urlstring uri

Canonical product page URL.

typestring

product: a catalog product a shop sells in many units, often in variants (TikTok Shop, Instagram and YouTube shopping); listing: a single item a person or business lists for sale (Facebook Marketplace). New values may be added; treat unknown values as product.

One ofproductlisting

titlestring

Product name or listing title, as the seller wrote it.

descriptionstringnullable

Description as plain text (paragraphs separated by blank lines); null when it has none or the source does not show it (lists and search results).

categorystringnullable

The platform's most specific category label (Bicycles, Vitamins & Supplements), as shown; not normalized across platforms.

category_idstringnullable

The platform's ID of that category (what its category browsing and filters take).

sellerobjectnullable

The shop or account selling it; null only when the source does not show it.

ShowHide 6 child fields
idstringnullable

Platform-native account ID; null when only the handle is known.

usernamestringnullable

Handle without the @; null when the account has none.

display_namestringnullable

Display name shown on the profile.

urlstring urinullable

Canonical profile URL.

avatar_urlstring urinullable

Profile picture URL. Platform CDN URLs can expire within hours.

is_verifiedbooleannullable

Platform verification badge; null where the platform has no badge.

pricenumbernullable

Current price in major units of currency (58.47), discounts applied; for a product whose variants cost different amounts, the lowest (the platform's "from" price). Coupons and shipping excluded. 0 = free; null when not shown.

max_pricenumbernullable

Highest current variant price, in major units of currency; equal to price when every variant costs the same; null when unknown (a source that shows one price).

original_pricenumbernullable

Price before the discount (the struck-through list price), in major units of currency; null when the platform shows no earlier price (not discounted, or not shown).

currencystringnullable

ISO 4217 code of every amount of this product (USD); null when no amount is shown.

availabilitystringnullable

in_stock: can be bought now; out_of_stock: sold out for now (a product can be restocked); pre_order: ships later; pending: a listing with a sale pending; sold: a listing marked sold. Null when the platform does not say. New values may be added; treat unknown values as null.

One ofin_stockout_of_stockpre_orderpendingsold

conditionstringnullable

Item condition, coarse: new, used (any grade) or refurbished; null when the platform does not say. The platform's own grade is condition_label. New values may be added; treat unknown values as used.

One ofnewusedrefurbished

condition_labelstringnullable

The condition as the platform labels it (Used - Like New, Used - Good, Pre-owned).

thumbnail_urlstring urinullable

Main product image URL. Platform CDN URLs can expire within hours.

mediaobject[]

Product images in the platform's order (main image first), then any product video; [] when none.

ShowHide 8 child fields
typestring

Kind of file. New values may be added; treat unknown values as other.

One ofimagevideoaudiogif

urlstring urinullable

Direct file URL; null when the platform withholds it, or when the link would only work from SocialTap's network or with a login. Often signed and expiring: see expires_at.

expires_atstring date-timenullable

When url stops working, RFC 3339 UTC, read from the platform's signed URL; null when unknown or when it does not expire.

thumbnail_urlstring urinullable

Poster or preview image URL.

widthintegernullable

Width in pixels.

heightintegernullable

Height in pixels.

duration_msintegernullable

Duration in milliseconds (video and audio only).

alt_textstringnullable

Accessibility text provided by the author or platform.

attributesobject[]

The product's specifications as name/value pairs, in the platform's order; [] when none.

ShowHide 2 child fields
namestring

Specification name, as shown (Brand, Material, Condition).

valuestring

Its value, as shown.

shippingobject

Delivery terms as shown to a buyer in the product's market; each null when not shown.

ShowHide 2 child fields
is_offeredbooleannullable

The seller ships it (false: local pickup only).

feenumbernullable

Standard shipping fee in major units of the product's currency; 0 = free shipping.

country_codestringnullable

ISO 3166-1 alpha-2 market the product is offered in; prices, stock and shipping are that market's.

platform_specificobject

Fields only this platform has, under its ID (platform_specific.<platform>): TikTok Shop's brand, rating, variants, stock and units sold; Marketplace's location and listing date. Each null when unknown.

ShowHide 1 child field
tiktokshopobjectnullable

A TikTok Shop product's own fields.

ShowHide 7 child fields
brandstringnullable

Brand name, as TikTok Shop shows it; null when it shows none.

ratingnumbernullable

Average review score out of 5 (metrics.review_count reviews behind it); null when unrated.

variantsobject[]

The purchasable variants (SKUs: a color, a size, a bundle), in TikTok Shop's order; [] for a product without variants (listed in unknown_fields when the source cannot see them).

ShowHide 8 child fields
idstring

Platform-native variant (SKU) ID; review.variant_id names it.

titlestringnullable

Variant name as shown, else its options joined (Color: Black, Size: M).

optionsobject[]

The option values that make this variant (Color: Black); [] for a product's only variant.

ShowHide 2 child fields
namestring

Option name, as shown (Color, Size).

valuestring

The variant's value of it (Black, M).

pricenumbernullable

Current price of this variant, in major units of the product's currency.

original_pricenumbernullable

This variant's price before the discount; null when no earlier price is shown.

availabilitystringnullable

Whether this variant can be bought now; null when not shown. New values may be added; treat unknown values as null.

One ofin_stockout_of_stockpre_order

stock_countintegernullable

Units in stock as the platform reports them (platforms may cap the number they show); null when hidden.

image_urlstring urinullable

Image of this variant (its color swatch or photo). Platform CDN URLs can expire within hours.

delivery_min_daysintegernullable

Fewest days TikTok Shop estimates delivery takes in the product's market.

delivery_max_daysintegernullable

Most days TikTok Shop estimates delivery takes in the product's market.

metricsobject

Counts at fetch time; null = hidden or not exposed, 0 = zero.

ShowHide 4 child fields
sold_countintegernullable

Units sold across every market since the product was listed, as TikTok Shop counts them; null when not shown.

review_countintegernullable

Reviews behind rating.

stock_countintegernullable

Units in stock across every variant, as TikTok Shop reports them (it may cap the number it shows); null when hidden.

rating_distributionobjectnullable

Reviews per star rating; null when TikTok Shop does not show the breakdown.

ShowHide 5 child fields
one_star_countintegernullable

Reviews rating 1 star.

two_star_countintegernullable

Reviews rating 2 stars.

three_star_countintegernullable

Reviews rating 3 stars.

four_star_countintegernullable

Reviews rating 4 stars.

five_star_countintegernullable

Reviews rating 5 stars.

shopobjectnullable

The selling shop's rating and counts (seller names the shop); null when the page shows none.

ShowHide 2 child fields
ratingnumbernullable

The shop's average review score out of 5, shown to one decimal; null when the shop is unrated.

metricsobject

The shop's counts at fetch time; null = not shown, 0 = zero.

ShowHide 4 child fields
follower_countintegernullable

Accounts following the shop.

sold_countintegernullable

Units the shop has sold across all its products and markets, as TikTok Shop counts them.

product_countintegernullable

Products the shop has on sale.

review_countintegernullable

Reviews of the shop's products, behind its rating.

approximate_fieldsstring[]

JSON paths of values rounded by the platform or parsed from display text ("10K+ sold"), and of Facebook's coarse listing coordinates. [] when all exact.

unknown_fieldsstring[]

JSON paths of lists whose [] means unknown rather than none (a list or search result that does not show attributes or variants); null already means unknown for every other field. [] when every list is known.

not_found and private_or_unavailable are item-level: the request was fine, the item can't be returned.

400

400 Bad Request: 2 error codes. Free: errors cost nothing.

invalid_inputNo retry

A parameter is missing or malformed, or the link is not one this endpoint takes.

Fix the parameter named in param as the message says. For a link of the wrong kind, call an endpoint listed in details.endpoints, when there is one.

invalid_cursorNo retry

The cursor is malformed or expired, belongs to another endpoint, or came with other parameters than the request that returned it.

Repeat the original request without cursor to start the list again.

401

401 Unauthorized: 1 error code. Free: errors cost nothing.

unauthorizedNo retry

The x-api-key header is missing, or its key is unknown or revoked. On the dashboard's routes: the session cookie is missing or expired.

Send a valid API key in the x-api-key header. No key yet? A person gets one at details.signup_url; an AI agent follows details.agent_auth_url.

402

402 Payment Required: 2 error codes. Free: errors cost nothing.

insufficient_creditsNo retry

The account does not have enough credits for this request.

Have a person buy credits at details.purchase_url (or make them a checkout link with details.checkout), then repeat the request. Do not retry automatically.

spend_limit_reachedNo retry

The API key reached its spend limit for this period. The account may still have credits.

Wait until details.resets_at, or raise the key's spend limit (PATCH /v1/api_keys/{id}). Do not retry automatically.

403

403 Forbidden: 2 error codes. Free: errors cost nothing.

forbiddenNo retry

The API key is valid but may not make this request, and details.reason says why: the account is suspended, the key lacks the route's scope, waits for its owner to confirm it by email, has expired, or was used from an IP outside its allowlist, or a rotated key's previous secret was used for a call that needs the admin scope. A running job stops with it too when its account is suspended or the key that created it is revoked or expires. It is about the key, never the item: a private item is private_or_unavailable, also 403, so branch on the code.

Act on details.reason. suspended: contact support. scope: use a key with details.required_scope. previous_secret: use the new secret. key_pending: have the owner open the emailed link. key_expired or key_revoked: create a new key. ip_not_allowed: call from an allowed IP.

private_or_unavailableNo retry

The item exists but is not public: it is private, age- or region-restricted, or needs a login to view. It shares 403 with forbidden (which is about the key), so branch on the code.

Only public items can be fetched. Do not retry.

404

404 Not Found: 1 error code. Free: errors cost nothing.

not_foundNo retry

The item does not exist or was deleted. On GET /v1/requests/{id}/response: the response was not kept (details.reason says why).

Check the link or ID. Do not retry.

429

429 Too Many Requests: 1 error code. Free: errors cost nothing.

rate_limitedYes, later

The account passed its runaway-protection ceiling: a high per-account limit that stops a broken client loop (plans have no rate limit). Requests without an API key (signup, the MCP server's tool listing and find_endpoint) are limited per IP address instead. It also stops an account whose failed requests in the last hour cost far more than its successful ones paid for: failures are free within a limit (the message says so), and successes raise it.

Wait the seconds in the retry-after header, then retry. If your steady traffic needs more, ask support to raise the ceiling; without an API key, send one.

500

500 Internal Error: 1 error code. Free: errors cost nothing.

internalYes, later

An unexpected error on SocialTap's side.

Retry with backoff. If it keeps happening, contact support with the request_id.

502

502 Bad Gateway: 1 error code. Free: errors cost nothing.

upstream_errorYes, later

The platform failed, or answered with something we could not read.

Retry with backoff. Failed requests are free.

503

503 Unavailable: 2 error codes. Free: errors cost nothing.

upstream_blockedYes, later

The platform refused every attempt, our own retries included.

Retry later with backoff. Failed requests are free.

overloadedYes, later

SocialTap was at capacity, or paused by its operators, and did not start the request. Nothing was fetched or charged.

Retry after the seconds in the retry-after header. Failed requests are free.

Pagination

Items come in pages, TikTok Shop's relevance order. To get the next page, send the same request plus cursor set to page.next_cursor from the previous response. Keep every other parameter the same (limit, max_age and fields may change); anything else that differs is rejected. When page.has_more is false the walk is over, and page.end_reason says why: only end means you have every item (the others say the platform or a page cap stopped the walk early).

Order
TikTok Shop's relevance order
Page size
Up to 30 products (the default; limit lowers it)
Cursor lifetime
1 hour; don't store cursors
Price
Per page, 1 credit

The page object

has_moreboolean

True when another page exists; then next_cursor is set. An empty page with has_more true is not the end.

next_cursorstringnullable

Pass as cursor, with the same other parameters, to get the next page; null at the end.

next_cursor_expires_atstring date-timenullable

When next_cursor stops working, RFC 3339 UTC; null at the end. Don't store cursors.

end_reasonstringnullable

Why there are no more pages; null while has_more is true. end: the list ended, or reached since/until. platform_limit: the platform stops serving further pages although the list goes on. max_pages: SocialTap's cap on pages in one walk. New values may be added. A short or empty page is not the end: only has_more false is.

One ofendplatform_limitmax_pages

Next page

cURL: next page
curl 'https://socialtap.dev/v1/tiktokshop/search_products?query=ashwagandha&cursor=c1.EXAMPLE_CURSOR' \
  -H "x-api-key: $SOCIALTAP_API_KEY"
  • The price is per page: each successful page costs the same, whatever limit is and however many items it has. Empty pages are charged too (an empty page with has_more: true is not the end).
  • A limit below 30 doesn't save credits: the next request serves the rest of the same platform page, which is fetched again and charged as a page each time, and items can shift between those requests if the platform changes the list. Omitting limit is the cheapest way to walk the list.
  • Errors are free, including a rejected cursor.
  • Pages served from the cache are free.
  • An expired or altered cursor, or one sent with different parameters, fails with invalid_cursor (HTTP 400): Repeat the original request without cursor to start the list again.

Pagination guide

Pricing

From 1 credit per page. Charged per successful page, whatever its number of items. Errors are free. The price depends on the source that produced the result, reported as meta.source; sources are tried cheapest first: Platform API → Public page.

SourcePrice per successful pagePer 1,000 pages
Platform API api1 credit$0.75–$1.97
Public page page1 credit$0.75–$1.97
Balance, sources and what you were charged

Your balance must be at least 1 credit to start a request; with less, it is refused with insufficient_credits (HTTP 402) and costs nothing. Only that minimum is set aside when the request starts.

meta.sourceSourceWhat it means
apiPlatform APIThe platform's public, logged-out API.
pagePublic pageData embedded in the platform's public web page.

meta.credits_charged and the x-credits-charged header show what you paid. How credits work · Packs

Endpoint ID tiktokshop.search_products · operationId tiktokshop.search_products.list · Product overview

Last updated