← Back to Skills Marketplace
lycici

Keyapi Tiktok Ecommerce

by lycici · GitHub ↗ · v1.0.0 · MIT-0
cross-platform ⚠ suspicious
99
Downloads
0
Stars
0
Active Installs
1
Versions
Install in OpenClaw
/install keyapi-tiktok-ecommerce
Description
Comprehensive TikTok Shop market intelligence — analyze products, shops, and categories with GMV, sales trends, reviews, creator attribution, and competitive...
README (SKILL.md)

keyapi-tiktok-ecommerce

Comprehensive TikTok Shop market intelligence — analyze products, shops, categories, pricing, GMV, reviews, and competitive dynamics across the entire e-commerce ecosystem.

This skill provides deep market intelligence on TikTok Shop using the KeyAPI MCP service. It covers the full e-commerce data spectrum: individual product analytics, shop-level performance, category hierarchy navigation, creator-driven sales attribution, and live-stream commerce data — all backed by large-scale historical datasets.

Use this skill when you need to:

  • Research product opportunities by analyzing sales trends, GMV, pricing, and competition
  • Evaluate specific products or shops with comprehensive performance metrics
  • Understand TikTok Shop category structures and identify high-growth niches
  • Analyze customer reviews and sentiment for product intelligence
  • Identify top shops and products in a category for competitive benchmarking
  • Attribute sales to specific creators or live-stream events

author: KeyAPI license: MIT repository: https://github.com/EchoSell/keyapi-skills

Prerequisites

Requirement Details
KEYAPI_TOKEN A valid API token from keyapi.ai. If you don't have one, register at the site to obtain your free token. Set it as an environment variable: export KEYAPI_TOKEN=your_token_here
Node.js v18 or higher
Dependencies Run npm install in the skill directory to install @modelcontextprotocol/sdk

author: KeyAPI license: MIT repository: https://github.com/EchoSell/keyapi-skills

MCP Server Configuration

All tool calls in this skill target the KeyAPI MCP server:

Server URL : https://mcp.keyapi.ai
Auth Header: Authorization: Bearer $KEYAPI_TOKEN

Setup (one-time):

# 1. Install dependencies
npm install

# 2. Set your API token (get one free at https://keyapi.ai/)
export KEYAPI_TOKEN=your_token_here

# 3. List all available tools to verify the connection
node scripts/run.js --list-tools

author: KeyAPI license: MIT repository: https://github.com/EchoSell/keyapi-skills

Analysis Scenarios

Product Nodes

User Need Node(s) Best For
Resolve product_id from a TikTok Shop share link get_product_id_from_share_link Entry point when user provides a product URL
Get real-time product details (price, stock, seller) get_product_detail Live product snapshot
Read customer reviews for a product get_product_reviews Voice-of-customer, review sentiment
Search and filter products with analytics metrics product_list_analytics Market scan, product opportunity discovery
Deep analytics on one or more products (sales, trends, creators) product_detail_analytics Comprehensive product performance audit
Historical sales volume and GMV trends for a product product_trends_analytics Trend analysis, seasonality detection
Aggregated historical review data and rating distribution product_reviews_analytics Reputation analysis, quality signals
Creators who promoted a product and their performance product_creators_analytics Creator attribution, partnership discovery
Videos associated with a product and their conversions product_videos_analytics Content-commerce attribution
Live streams that featured a product product_livestreams_analytics Live commerce performance
Ranked product list by sales, GMV, or other metrics product_ranking_analytics Top-N products in category, competitive ranking
Find visually similar products using an image product_image_search_analytics Visual search, competitor product matching

Shop Nodes

User Need Node(s) Best For
Get live product listings from a specific shop get_shop_products Real-time shop catalog snapshot
Search and filter shops with analytics data shop_list_analytics Shop discovery and shortlisting
Comprehensive shop performance audit shop_detail_analytics GMV history, product mix, creator network
Historical GMV and sales trends for a shop shop_trends_analytics Shop growth trajectory
Product list for a shop with sales analytics shop_products_analytics Shop's product performance breakdown
Creators affiliated with a shop and their contributions shop_creators_analytics Creator network and revenue attribution
Videos promoting a shop's products shop_videos_analytics Video commerce effectiveness
Historical live streams for a shop shop_livestreams_analytics Live commerce history and GMV
Ranked shop list by GMV, product count, or sales shop_ranking_analytics Top shops in category, competitive landscape

Category Nodes

User Need Node(s) Best For
List top-level product categories primary_categories_analytics Category hierarchy entry point
List subcategories under a primary category secondary_categories_analytics Drill-down to L2 categories
List subcategories under a secondary category tertiary_categories_analytics Drill-down to L3 categories

author: KeyAPI license: MIT repository: https://github.com/EchoSell/keyapi-skills

Workflow

Step 1 — Identify the Research Objective and Select Nodes

Clarify the user's goal and identify the appropriate entry point and supporting nodes.

Common entry points:

  • User provides a product share link → Start with get_product_id_from_share_link to resolve product_id.
  • User provides a product name or keyword → Use product_list_analytics to discover matching products.
  • User asks about a category → Resolve the full category hierarchy first (see Step 1a below).
  • User provides a shop name or ID → Use shop_list_analytics or shop_detail_analytics.
  • Competitive market analysis → Combine product_ranking_analytics + shop_ranking_analytics + category filters.

Step 1a — Resolve Category IDs

⚠️ When the user asks about a product category or wants to filter by category, always resolve the full category hierarchy first:

  1. Call primary_categories_analytics → obtain category_id (L1)
  2. Call secondary_categories_analytics with category_id → obtain category_l2_id (L2)
  3. Call tertiary_categories_analytics with category_l2_id → obtain category_l3_id (L3)

Use the appropriate level of category ID as a filter in subsequent product or shop queries.

Step 2 — Retrieve API Schema

Before calling any node, inspect its input schema to confirm required parameters and valid values:

node scripts/run.js --schema \x3Ctool_name>

# Examples
node scripts/run.js --schema product_list_analytics
node scripts/run.js --schema get_product_id_from_share_link

For analytics nodes, pay particular attention to filter parameters such as category_id, category_l2_id, category_l3_id, region, min_spu_avg_price, max_spu_avg_price, product_sort_field, sort_type, and page_num/page_size.

Step 3 — Call APIs and Cache Results Locally

Execute the required tool calls and persist all responses to the local cache.

Calling a tool (using scripts/run.js):

# Single page call — result is cached automatically
node scripts/run.js --tool \x3Ctool_name> --params '\x3Cjson_args>' --pretty

# Fetch all pages at once (auto-pagination)
node scripts/run.js --tool \x3Ctool_name> --params '\x3Cjson_args>' --all-pages --page-size 50

# Force a fresh call, skip cache
node scripts/run.js --tool \x3Ctool_name> --params '\x3Cjson_args>' --no-cache

Example — resolve product_id from share link:

node scripts/run.js --tool get_product_id_from_share_link \
  --params '{"share_url":"https://www.tiktok.com/t/ZPH7PbVhQDwt7-vS8eu/"}' --pretty

Example — get product analytics (all pages):

node scripts/run.js --tool product_list_analytics \
  --params '{"region":"US","category_id":"600001"}' \
  --all-pages

Pagination for analytics endpoints:

All *_analytics endpoints use page_num (1-indexed) and page_size (max 10). run.js injects these automatically if not specified. Use --all-pages to iterate all pages automatically.

--page-num 1  --page-size 10   → first page (default)
--all-pages                    → all pages merged into one result

Cache directory structure:

.keyapi-cache/
├── products/
│   └── {product_id}/
│       ├── detail.json              # get_product_detail / product_detail_analytics
│       ├── reviews.json             # get_product_reviews / product_reviews_analytics
│       ├── trends.json              # product_trends_analytics
│       ├── creators.json            # product_creators_analytics
│       ├── videos.json              # product_videos_analytics
│       └── livestreams.json         # product_livestreams_analytics
├── shops/
│   └── {shop_id}/
│       ├── detail.json              # shop_detail_analytics
│       ├── products.json            # get_shop_products / shop_products_analytics
│       ├── creators.json            # shop_creators_analytics
│       ├── videos.json              # shop_videos_analytics
│       ├── livestreams.json         # shop_livestreams_analytics
│       └── trends.json              # shop_trends_analytics
├── categories/
│   ├── primary.json                 # primary_categories_analytics
│   ├── secondary_{category_id}.json # secondary_categories_analytics
│   └── tertiary_{category_l2_id}.json # tertiary_categories_analytics
├── searches/
│   ├── products/
│   │   └── {md5_of_query_params}.json  # product_list_analytics
│   └── shops/
│       └── {md5_of_query_params}.json  # shop_list_analytics
└── rankings/
    ├── products_{params_hash}.json   # product_ranking_analytics
    └── shops_{params_hash}.json      # shop_ranking_analytics

Cache-first policy:

Before every API call, check whether a cached result already exists for the given entity and node. If a valid cache file exists, load from disk and skip the API call. Category data is especially stable and should be aggressively cached.

Cover image processing:

After each API call, scan all response image URLs. If any URL's host matches echosell-images.tos-ap-southeast-1.volces.com, collect those URLs and call batch_download_cover_images in a single batch request. Replace the original URLs in your working dataset with the converted URLs returned by this node.

Step 4 — Synthesize and Report Findings

After collecting all API responses, produce a structured market intelligence report tailored to the user's objective:

For product analysis:

  1. Product Overview — Title, price range, seller info, category path (L1 → L2 → L3), rating.
  2. Sales Performance — Historical sales volume, GMV trend, growth rate, seasonality patterns.
  3. Customer Sentiment — Review volume, rating distribution, key positive/negative themes from reviews.
  4. Creator & Content Attribution — Top creators promoting the product, video and live-stream conversion rates.
  5. Competitive Position — Ranking within category, price positioning vs. competing products.

For shop analysis:

  1. Shop Profile — Shop name, category focus, total products, seller tier.
  2. Revenue Intelligence — GMV history, monthly sales trend, growth trajectory.
  3. Product Portfolio — Top-performing products, category distribution, price range strategy.
  4. Creator Ecosystem — Associated creators, their individual GMV contributions, collaboration patterns.
  5. Market Position — Category ranking, competitive comparison.

For category/market analysis:

  1. Category Landscape — Category hierarchy, total market size estimate, top sub-categories.
  2. Top Products & Shops — Ranking leaders, their metrics, and differentiation factors.
  3. Trend Analysis — Rising vs. declining sub-categories, emerging product types.
  4. Opportunity Signals — Underserved niches, high-growth segments, pricing white spaces.

author: KeyAPI license: MIT repository: https://github.com/EchoSell/keyapi-skills

Common Rules

Rule Detail
Pagination All *_analytics endpoints use page_num (starts at 1) and page_size. Never use page 0.
Cover images Batch-convert all image URLs from echosell-images.tos-ap-southeast-1.volces.com via batch_download_cover_images before storing or displaying.
Success check code = 0 → success. Any other value → failure. Always check the response code before processing data.
Retry on 500 If code = 500, retry the identical request once after a brief pause before reporting the error.
Cache first Always check the local .keyapi-cache/ directory before issuing a live API call. Category data is especially cacheable.
Category resolution When filtering by category, always resolve the full hierarchy (L1 → L2 → L3) using the category analytics nodes before applying category filters.
Product ID from link When the user provides a product share URL, always call get_product_id_from_share_link first to extract the product_id.

author: KeyAPI license: MIT repository: https://github.com/EchoSell/keyapi-skills

Error Handling

Code Meaning Action
0 Success Continue workflow normally
400 Bad request — invalid or missing parameters Validate input against the tool schema; check category IDs and product IDs are correct
401 Unauthorized — token missing or expired Confirm KEYAPI_TOKEN is set correctly; visit keyapi.ai to renew
403 Forbidden — plan quota exceeded or feature restricted Review plan limits at keyapi.ai
404 Resource not found — product or shop not indexed Verify IDs are correct; try a search-based node to locate the resource
429 Rate limit exceeded Wait 60 seconds, then retry
500 Internal server error Retry once after 2–3 seconds; if it persists, log the full request and response and skip this node
Other non-0 Unexpected error Log the full response body and surface the error message to the user
Usage Guidance
This skill appears to be what it claims: a Node-based client for KeyAPI's MCP server. Before installing, consider: (1) npm install will fetch dependencies from the public npm registry — inspect package.json and the dependency @modelcontextprotocol/sdk if you want extra assurance; (2) the script can persist your KEYAPI_TOKEN to a .env file in the skill directory and will create a .keyapi-cache directory for responses — if you prefer not to persist credentials, set KEYAPI_TOKEN in your environment instead of entering it interactively and remove any .env after use; (3) the tool makes network calls to the default server (https://mcp.keyapi.ai) — only provide tokens you trust to be used with that service; and (4) review the included scripts/run.js if you need to verify exactly what data is sent or cached.
Capability Analysis
Type: OpenClaw Skill Name: keyapi-tiktok-ecommerce Version: 1.0.0 The skill bundle provides a legitimate interface for TikTok Shop market intelligence via the KeyAPI MCP service. The primary component, `scripts/run.js`, is a well-structured helper script that manages authentication, local caching in `.keyapi-cache/`, and API pagination. While the script automatically handles sensitive data like the `KEYAPI_TOKEN` and interacts with the remote endpoint `https://mcp.keyapi.ai`, its behavior is entirely consistent with the stated purpose of the skill, and no evidence of malicious intent, data exfiltration, or harmful prompt injection was found.
Capability Assessment
Purpose & Capability
Name/description (TikTok Shop market intelligence) match the implementation: a Node.js MCP tool runner that talks to the KeyAPI MCP server. Required binary (node) and required env (KEYAPI_TOKEN) are appropriate and expected for this client.
Instruction Scope
SKILL.md and scripts/run.js instruct the agent to run npm install and invoke scripts/run.js to call MCP tools. The runtime will read/write a .env file if the token is entered interactively and will create a .keyapi-cache directory for cached API responses; these filesystem actions are disclosed in the README. The instructions do not attempt to read unrelated system files or additional environment secrets.
Install Mechanism
There is no packaged install spec; the skill relies on npm install to fetch @modelcontextprotocol/sdk from the npm registry. This is a standard, expected mechanism (no obscure download URLs or archive extraction).
Credentials
Only KEYAPI_TOKEN (primary credential) is required, which is proportional to a service client. The code may persist the token to a .env file in the skill directory if entered interactively — this behavior is explicit in the code and docs.
Persistence & Privilege
The skill does not request elevated platform privileges and always:false. It will persist the API token to .env (if user enters it interactively) and create a .keyapi-cache directory and output files when asked; it does not modify other skills or system-wide agent settings.
How to Use
  1. Make sure OpenClaw is installed (local or Docker)
  2. Run the install command in chat: /install keyapi-tiktok-ecommerce
  3. After installation, invoke the skill by name or use /keyapi-tiktok-ecommerce
  4. Provide required inputs per the skill's parameter spec and get structured output
Version History
v1.0.0
Initial release of keyapi-tiktok-ecommerce — comprehensive TikTok Shop market intelligence tools. - Analyze products, shops, and categories on TikTok Shop using GMV, sales trends, reviews, and more. - Access detailed analytics nodes: product, shop, and category performance, creator attribution, and live-stream commerce. - Step-by-step workflow to resolve category and product IDs, filter analytics, and interpret results. - Requires KEYAPI_TOKEN and Node.js; easy setup via npm. - Includes detailed usage scenarios and command examples for all supported data queries.
Metadata
Slug keyapi-tiktok-ecommerce
Version 1.0.0
License MIT-0
All-time Installs 0
Active Installs 0
Total Versions 1
Frequently Asked Questions

What is Keyapi Tiktok Ecommerce?

Comprehensive TikTok Shop market intelligence — analyze products, shops, and categories with GMV, sales trends, reviews, creator attribution, and competitive... It is an AI Agent Skill for Claude Code / OpenClaw, with 99 downloads so far.

How do I install Keyapi Tiktok Ecommerce?

Run "/install keyapi-tiktok-ecommerce" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.

Is Keyapi Tiktok Ecommerce free?

Yes, Keyapi Tiktok Ecommerce is completely free, licensed under MIT-0. You can download, install and use it at no cost.

Which platforms does Keyapi Tiktok Ecommerce support?

Keyapi Tiktok Ecommerce is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).

Who created Keyapi Tiktok Ecommerce?

It is built and maintained by lycici (@lycici); the current version is v1.0.0.

💬 Comments