agentleFS
nikhonitnikhonit/social-media-api-skills/skills/tiktok-shop-api/SKILL.md

tiktok-shop-api

Skill3 starsChanged 3 months agoMIT-0View on GitHub

TikTok Shop data toolkit via ScraperSocial — product detail, product reviews, shop catalogues, creator showcases and product search.

1 other project uses a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

2 rules. About 0 are common, 1 is distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Every script also accepts --limit, --cursor, --fields, --format and --fresh.

    line 73
  2. Distinctive:

    Every response uses the same envelope:

    line 81

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

TikTok Shop API skill

Read public TikTok Shop data as clean JSON. This TikTok Shop API skill returns a product, its reviews, a shop's catalogue, a creator's showcase, and keyword product search — all at 3 credits. TikTok Shop is where a large share of social commerce now happens, and it is barely covered by conventional e-commerce data tools.

This skill wraps 5 live TikTok Shop endpoints from the ScraperSocial API. Public data only, returned as clean JSON.

When to use this skill

  • You are researching what sells on TikTok Shop in a category.
  • You need reviews for a TikTok Shop product to gauge sentiment or quality.
  • You are tracking which products a creator promotes in their showcase.
  • You are comparing a product's TikTok Shop listing against other marketplaces.

Do not use this skill when

  • You need seller-account data — orders, fulfilment, payouts. That is account-scoped; TikTok's Shop Partner API covers it.
  • You confused this with the main TikTok skill. Videos, transcripts and creator stats live in tiktok-api; this skill is the commerce surface only.
  • You need guaranteed live stock or price. Responses may be cached; use --fresh when it matters.

Setup

export SCRAPERSOCIAL_KEY=sk_live_...   # https://scrapersocial.com/app/keys

Signing up at scrapersocial.com/signup includes 100 free credits, no card required.

Permissions and scope

These scripts do exactly three things and nothing else: read one environment variable (SCRAPERSOCIAL_KEY), send HTTPS requests to https://api.scrapersocial.com (the host is a constant in the code, not configurable), and print JSON. They run as node scripts/<name>.js with no other shell use, no file writes and no persistence. call_endpoint.js accepts only the 5 documented /v1/tiktokshop/ paths in the table below and refuses anything else before a request is made.

Scripts

ScriptWhat it doesInputCredits
get_product.jsGet TikTok Shop product.url3 credits
get_product_reviews.jsList TikTok Shop product reviews.url3 credits per review
get_products.jsList TikTok Shop products.url3 credits per product
search.jsList TikTok Shop search.query3 credits per product
get_user_showcase.jsList TikTok Shop user showcase.handle3 credits per product
call_endpoint.jsCall any /v1/tiktokshop/ endpoint directlypath + paramsvaries

Every script also accepts --limit, --cursor, --fields, --format and --fresh. --limit is clamped to 50: above that the API returns an async job instead of data.

Example

node skills/tiktok-shop-api/scripts/search.js "phone case"

Every response uses the same envelope:

{ "data": {}, "meta": { "count": 20, "next_cursor": "..." }, "request_id": "a18e4ef88ad4b00b" }

meta appears on paginated endpoints only. Keep request_id — support traces calls with it.

Endpoints

EndpointInputReturnsCreditsPaginated
/v1/tiktokshop/producturlproduct3 creditsno
/v1/tiktokshop/product-reviewsurlreview3 credits per reviewyes
/v1/tiktokshop/productsurlproduct3 credits per productyes
/v1/tiktokshop/searchqueryproduct3 credits per productyes
/v1/tiktokshop/user-showcasehandleproduct3 credits per productyes

Costs shown per item for paginated endpoints, per call otherwise. Failed calls are not charged.

FAQ

How do I search TikTok Shop products?

search.js with a query returns matching products at 3 credits each.

How do I get reviews for a product?

get_product_reviews.js with the product URL, 3 credits per review returned.

What is a creator showcase?

get_user_showcase.js returns the products a given creator features — useful for tracking affiliate promotion.

Is this an official TikTok Shop API?

No. ScraperSocial is independent and not affiliated with TikTok or ByteDance. It returns publicly available listing data only.

Links

Disclaimer

ScraperSocial is an independent product and is not affiliated with, endorsed by, or sponsored by any platform named in this repository. All product names, logos and brands are property of their respective owners. These skills return only publicly available data.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.