- name
- apiclaw
- description
- APIClaw API platform overview — AI-powered commerce data infrastructure. Provides programmatic access to 200M+ Amazon products with real-time data across 6 endpoints: category browsing, market metrics, product search, competitor lookup, realtime ASIN detail, and AI review analysis. Use when user asks: what APIClaw can do, available API endpoints, how to get started, API capabilities overview, credit usage, or general commerce data questions. For deep Amazon product selection strategies and analysis workflows, use the Amazon-analysis-skill instead. Requires APICLAW_API_KEY.
- metadata
- {"openclaw": {"requires": {"env": ["APICLAW_API_KEY"]}, "primaryEnv": "APICLAW_API_KEY"}}
APIClaw — Commerce Data Infrastructure for AI Agents
Real-time access to 200M+ Amazon products. 6 endpoints, one API key. Language rule: Respond in the user's language.
Quick Start
- Get API key: apiclaw.io/api-keys
- Set env:
export APICLAW_API_KEY='hms_live_xxx' - Base URL:
https://api.apiclaw.io/openapi/v2 - Auth:
Authorization: Bearer YOUR_API_KEY - All endpoints: POST with JSON body
New keys need 3-5 seconds to activate. If 403, wait and retry.
API Endpoints
| # | Endpoint | What It Does | Key Output |
|---|---|---|---|
| 1 | categories | Browse Amazon category tree | categoryName, categoryPath, productCount, hasChildren |
| 2 | markets/search | Market-level aggregate metrics | sampleAvgMonthlySales, sampleAvgPrice, sampleBrandCount, topSalesRate, sampleFbaRate |
| 3 | products/search | Product search with 14 preset strategies | asin, title, price, bsrRank, atLeastMonthlySales, rating, ratingCount |
| 4 | products/competitor-lookup | Competitor analysis by keyword/ASIN | competitive products with sales, revenue, seller info |
| 5 | realtime/product | Live single-ASIN detail | title, rating, features, variants, bestsellersRank, buyboxWinner |
| 6 | reviews/analyze | AI-powered review insights | sentimentDistribution, consumerInsights (painPoints, buyingFactors, etc.) |
Endpoint Details
1. Categories
Browse or search Amazon's category hierarchy.
POST /openapi/v2/categories
{"categoryKeyword": "pet supplies"} # search by keyword
{"parentCategoryPath": ["Pet Supplies"]} # browse children⚠️ Use categoryKeyword (not keyword) and parentCategoryPath (not parentCategoryName).
2. Markets
Category-level market metrics — answer "Is this market worth entering?"
POST /openapi/v2/markets/search
{"categoryPath": ["Pet Supplies", "Dogs", "Toys"], "topN": "10"}⚠️ topN must be a string ("3", "5", "10", "20"), NOT an integer.
Returns: sampleAvgMonthlySales, sampleAvgPrice, sampleBrandCount, sampleSellerCount, topSalesRate (concentration), sampleNewSkuRate, sampleFbaRate.
3. Products
Product search with filters or 14 built-in selection modes.
POST /openapi/v2/products/search
{"keyword": "yoga mat", "mode": "beginner"}14 modes: beginner, fast-movers, emerging, long-tail, underserved, new-release, fbm-friendly, low-price, single-variant, high-demand-low-barrier, broad-catalog, selective-catalog, speculative, top-bsr.
Key fields: atLeastMonthlySales (lower-bound estimate), bsrRank (integer), ratingCount (not reviewCount), price, profitMargin, fbaFee.
4. Competitors
Competitor discovery by keyword, brand, or specific ASIN.
POST /openapi/v2/products/competitor-lookup
{"keyword": "wireless earbuds"}
{"asin": "B09V3KXJPB"}Returns same product fields as products/search.
5. Realtime Product
Live data for a single ASIN — current listing content and pricing.
POST /openapi/v2/realtime/product
{"asin": "B09V3KXJPB"}Key response fields:
| Field | Type | Note |
|---|---|---|
title, brand | String | Basic info |
rating, ratingCount | Float/Int | Rating data |
ratingBreakdown | Object | {five_star: {percentage, count}, ...} |
features | List | Bullet points |
bestsellersRank | Array | [{category, rank}, ...] — NOT a single integer |
buyboxWinner | Object | {price, fulfillment, seller} — price is nested here |
topReviews | List | Top reviews with title, body, rating |
variants | List | All variants with dimensions |
⚠️ Does NOT return: atLeastMonthlySales, profitMargin, fbaFee, sellerCount. Use products/competitor-lookup for those. ⚠️ Price is nested: buyboxWinner.price, NOT top-level price.
6. Review Analysis
AI-powered consumer insights from customer reviews.
POST /openapi/v2/reviews/analyze
# Single or multiple ASINs (mode + asins required)
{"mode": "asin", "asins": ["B09V3KXJPB"]}
{"mode": "asin", "asins": ["B09V3KXJPB", "B08YYYYY"]}
# Category-level insights
{"mode": "category", "categoryPath": "Pet Supplies,Dogs,Toys", "period": "90d"}
# Filter to specific dimensions
{"mode": "asin", "asins": ["B09V3KXJPB"], "labelType": "painPoints"}⚠️ mode is required ("asin" or "category"). ⚠️ Use asins (plural, array), NOT asin (singular string).
11 insight dimensions (labelType): painPoints, improvements, buyingFactors, issues, positives, scenarios, keywords, userProfiles, usageTimes, usageLocations, behaviors.
Returns: totalReviews, avgRating, sentimentDistribution, ratingDistribution, consumerInsights, topKeywords, verifiedRatio.
⚠️ Field Differences Across Endpoints
The 4 endpoint types return different fields. Do NOT assume they share the same structure.
| Data | markets | products/competitors | realtime/product | reviews/analyze |
|---|---|---|---|---|
| Monthly Sales | sampleAvgMonthlySales | ✅ atLeastMonthlySales | ❌ | ❌ |
| Price | sampleAvgPrice | price | buyboxWinner.price | ❌ |
| BSR | sampleAvgBsr | bsrRank (integer) | bestsellersRank (array) | ❌ |
| Rating | sampleAvgRating | rating | rating | avgRating |
| Review Count | sampleAvgReviewCount | ratingCount | ratingCount | totalReviews |
| Sentiment | ❌ | ❌ | ❌ | ✅ sentimentDistribution |
| Consumer Insights | ❌ | ❌ | ❌ | ✅ consumerInsights |
| Pain Points | ❌ | ❌ | ❌ (manual from topReviews) | ✅ AI-analyzed |
| Profit Margin | ❌ | profitMargin | ❌ | ❌ |
| FBA Fee | ❌ | fbaFee | ❌ | ❌ |
| Features/Bullets | ❌ | ❌ | ✅ features | ❌ |
| Variants | ❌ | variantCount (integer) | variants (full list) | ❌ |
What Each Endpoint Is Best For
| Need | Use This |
|---|---|
| Sales, pricing, competition data | products/search or products/competitor-lookup |
| Live pricing, reviews, listing content | realtime/product |
| Category-level market sizing | markets/search |
| Consumer pain points, sentiment, buying factors | reviews/analyze |
| Category browsing / validation | categories |
| Full product picture | Combine products (quantitative) + realtime (qualitative) + reviews (insights) |
Known Quirks
topNandnewProductPeriodare strings — use"10"not10listingAgeis a string — use"180"not180- All response
.datais an array — use.data[0]not.data.fieldName ratingCountnotreviewCount— the field is calledratingCounteverywherebsrRank(integer) in products/competitors vsbestsellersRank(array) in realtime- Rate limit: 100 req/min, 10 req/sec burst
Credits
- Each API call consumes credits
- Response includes
meta.creditsConsumedandmeta.creditsRemaining - Minimum 50 reviews required for
reviews/analyze(returnsINSUFFICIENT_REVIEWSerror otherwise) - Plans & rates: apiclaw.io/pricing
Data Notes
- Monthly sales (
atLeastMonthlySales) is a lower-bound estimate — actual may be higher - Realtime vs database:
realtime/productis live;products/competitorshave ~T+1 delay - Currently Amazon US only (amazon.com) — more marketplaces planned
- Sales estimation fallback: When
atLeastMonthlySalesis null → Monthly sales ≈ 300,000 / BSR^0.65
Go Deeper
For advanced Amazon product research — 14 selection strategies, risk assessment, pricing analysis, listing optimization, and operational monitoring — install the dedicated skill:
clawhub install Amazon-analysis-skillLinks
- Website: apiclaw.io
- API Docs: api.apiclaw.io/api-docs
- GitHub: github.com/SerendipityOneInc
- Support: support@apiclaw.io