API Docs
Use these endpoints to submit Amazon data collection tasks for ASINs, keywords, BSR best-seller lists, category top-400 lists and seller stores. Once submitted, tasks are collected asynchronously and data is delivered per your agreement. See the field reference tables in the appendix below.
Base URL
All endpoints share the https://ksicdata.com/api prefix. The full URL is the base URL + endpoint name, for example:
https://ksicdata.com/api/addAsinTask
https://ksicdata.com/api/addKeywordTask
https://ksicdata.com/api/addBsr100Task
https://ksicdata.com/api/addCategory400Task
https://ksicdata.com/api/addSellerTask
https://ksicdata.com/api/addSellerAsinTask
- Method:
POST; include theContent-Type: application/jsonheader. - Request body: a JSON array for batch submission — up to
2000items per request; exceeding it returns error10002. - Response format:
JSON, see "Common Response".
Authentication
All endpoints require authentication. Send the platform-issued token in a request header or cookie:
# Option 1: request header
ks-token: YOUR_TOKEN
# Option 2: cookie
ks-token=YOUR_TOKEN
Your identity is resolved from the ks-token server-side — do not send a userId parameter.
401 (unauthorized).
Common Response
All endpoints share the same response structure:
| Field | Type | Description |
|---|---|---|
code | integer | Status code. 0 means success; any other value means failure — see "Error Codes" |
msg | string | Response message |
t | long | Server timestamp in milliseconds |
Success response example
{
"code": 0,
"msg": "请求成功",
"t": 1735891200000
}
Failure response example
{
"code": 10002,
"msg": "超出批量限制",
"t": 1735891200000
}
Submit ASIN Task
Submit a list of ASINs to collect the corresponding product detail (listing) data, including title, price, rating, review count, BSR rank, variations, images and more.
https://ksicdata.com/api/addAsinTask
Request Parameters
Body is a JSON array; batch submission supported, up to 2000 items per request.
| Parameter | Type | Required | Description |
|---|---|---|---|
asin | string | Yes | ASIN code, e.g. B0CB3TJ46F |
region | string | Yes | Marketplace code, e.g. us — see "Supported Marketplaces" |
zipCode | string | Yes | Delivery postal code (required), used to simulate a local delivery address, affecting displayed price and stock — see "Available Postal Codes" |
Request Example
[
{
"asin": "B0CB3TJ46F",
"region": "us",
"zipCode": "10001"
}
]
cURL Example (click to expand)
curl -X POST "https://ksicdata.com/api/addAsinTask" \
-H "Content-Type: application/json" \
-H "ks-token: YOUR_TOKEN" \
-d '[
{
"asin": "B0CB3TJ46F",
"region": "us",
"zipCode": "10001"
}
]'
Response Example
{
"code": 0,
"msg": "请求成功",
"t": 1735891200000
}
Collected Data Sample (click to expand)
Sample data collected by addAsinTask (product detail page):
{
"ac": true,
"aplus": false,
"asin": "B0CB3TJ46F",
"bought": "100+ bought",
"brandName": "Fitede",
"bs": false,
"bundleItems": [
"B0CQ7WZBJ2",
"B09M8NTXMG"
],
"buybox": 16.49,
"climatePledgeFriendly": false,
"currency": "$",
"customersAspects": [
"Functionality",
"Fit",
"Value for money"
],
"customersSay": "Customers report that the transmission filter oil pan gasket kit works great. However, the fit and value for money receive mixed feedback - while some say it fits perfectly and offers decent pricing, others mention compatibility issues with specific models like the 2015 Rogue SL and find it overpriced.",
"date": 1788933552498,
"description": "Advantage: Tested & Certified to Meet or Exceed OEM Quality Standards. 100% Tested Before Leaving the Factory. Made of High Quality Material. Replace Part Number: 31728-1XF03, 31726-1XF00, 31728-1XF02, 31728-1XF0A, 31728-1XH0A, 31728-1XZ0A, 31728-1XZ0D, 31397-1XF0D, 2824A02, 2824A006, 2824A007, 2705A015, 2920A096, 5191890AA, 92724H, JF011E, RE0F10A, RE0F10B Compatible with Nissan Vehicles: 2007-2013 Altima 2011-2016 Juke 2013-2015 NV200 2008-2016 Rogue 2014-2015 Rogue Select 2009-2012 Sentra Compatible with Mitsubishi Vehicles: 2008-2015 Lancer 2008-2017 Outlander 2011-2017 Outlander Sport Compatible with Other Vehicles: 2007-2012 Dodge Caliber 2007-2017 Jeep Compass/Patriot Includes: 1 x Automatic Transmission Filter 1 x Transmission Oil Cooler Filter 1 x Rubber Pan Gasket Warranty: The Transmission Filter Assembly come with 12 Months Warranty. Hassle-Free Return and Refund Policy. Please Buy it with Your Confidence.",
"dimensions": "5.71 x 5.12 x 2.24 inches;9.1 ounces",
"featureNames": [],
"featureValues": [],
"firstAvailable": "July 4, 2023",
"firstDate": 1688400000000,
"fivePoint": [
"【Function】The Transmission Filter is Made of High-Quality Materials,Which can Filter the Oil,Remove the Impurities,Keep the Oil Clean,Prevent the Valve Body and Other Parts of the Blockage,Which can Effectively Extend the Service Life of the Gearbox.",
"【Replaces#】31728-1XF03, 31726-1XF00, 31728-1XF02, 31728-1XF0A, 31728-1XH0A, 31728-1XZ0A, 31728-1XZ0D, 31397-1XF0D, 2824A02, 2824A006, 2824A007, 2705A015, 2920A096, 5191890AA, 92724H, JF011E, RE0F10A, RE0F10B.Please Check the OEM Part Number and Make Sure Your Part Number Matches this Part Number Before Buying!",
"【Compatible】Fit for JF011E RE0F10A Transmission.Fit for Nissan Vehicles:2007-2013 Altima;2011-2016 Juke;2013-2015 NV200;2008-2016 Rogue;2014-2015 Rogue Select;2009-2012 Sentra.Fit for Mitsubishi Vehicles:2008-2015 Lancer;2008-2017 Outlander;2011-2017 Outlander Sport.Fit for 2007-2012 Dodge Caliber.Fit for 2007-2017 Jeep Compass/Patriot.",
"【Premium Quality】Tested & Certified to Meet or Exceed OEM Quality Standards.All Products are 100% Tested Before Leaving the Factory.Made of High Quality Material.",
"【Warranty】The Transmission Filter Assembly come with 12 Month Warranty. Hassle-free Return and Refund Policy. Please Buy it with Your Confidence."
],
"mainImage": "https://m.media-amazon.com/images/I/51puNJL+mFL._AC_SL1500_.jpg",
"mainRank": {
"rank": 46987,
"rankName": "Automotive"
},
"newOnAmz": false,
"newReleases": false,
"nodeIds": [
"15684181",
"15719731",
"15727061",
"15727281",
"15727291"
],
"nodeNames": [
"Automotive",
"Replacement Parts",
"Filters",
"Transmission Filters & Accessories",
"Filter & Gasket Kits"
],
"offerDisplays": [
{
"name": "Ships from",
"value": "Amazon"
},
{
"name": "Sold by",
"value": "FTDFITS"
},
{
"name": "Returns",
"value": "FREE 30-day refund/replacement"
},
{
"name": "Gift options",
"value": "Available at checkout Secure transaction"
}
],
"otherRanks": [
{
"nodeId": "15727291",
"rank": 32,
"rankName": "Automotive Replacement Transmission Filter & Gasket Kits"
},
{
"nodeId": "15724571",
"rank": 230,
"rankName": "Automotive Replacement Transmissions & Parts"
}
],
"price": 16.49,
"productDocuments": false,
"productInformation": [
{
"name": "Manufacturer",
"value": "Fitede"
},
{
"name": "Brand",
"value": "Fitede"
},
{
"name": "Model",
"value": "Transmission Filter"
},
{
"name": "Item Weight",
"value": "9.1 ounces"
},
{
"name": "Package Dimensions",
"value": "5.71 x 5.12 x 2.24 inches"
},
{
"name": "Item model number",
"value": "31728-1XF02"
},
{
"name": "Exterior",
"value": "Machined"
},
{
"name": "Manufacturer Part Number",
"value": "FT-022-FT"
},
{
"name": "ASIN",
"value": "B0CB3TJ46F"
},
{
"name": "Customer Reviews",
"value": " 4.4 4.4 out of 5 stars (429) 4.4 out of 5 stars"
},
{
"name": "Best Sellers Rank",
"value": " #46,987 in Automotive (See Top 100 in Automotive) #32 in Automotive Replacement Transmission Filter & Gasket Kits #230 in Automotive Replacement Transmissions & Parts "
},
{
"name": "Date First Available",
"value": "July 4, 2023"
}
],
"ratings": 4.4,
"relateMap": {
"Similar items that may deliver to you quickly": [
"B0D7MGY9RF",
"B0F5P38LFN",
"B0FJ8R4C6Q",
"B0D8ZDWWH1",
"B0GDCN9RKF",
"B0BJTVNDBD",
"B0FSJJKVYD",
"B0BHWN6CY1",
"B0DPZ1SCJN",
"B0GDCSXP8J",
"B0D4PZZM21",
"B0G1RM7DJN",
"B0D4Y3N9KZ",
"B0DMZPF6WS",
"B0GSFNJVYG",
"B0D7MMN348",
"B0GSFXLKHW",
"B0FXTQ9BF7",
"B0B31KG685",
"B0D7MM9NQM",
"B0D7MJ3862",
"B0CTMFDSH3",
"B0BDVHY45M",
"B0D49D3BC3",
"B09NKJ497F",
"B0FHZRQFQW",
"B0H7R8KRX4",
"B0CM5LR54X",
"B0FCXR8SMD"
],
"Frequently bought together": [
"B093R9YZ75",
"B0CQJWX183"
]
},
"reviews": 429,
"secondaryImage": [
"https://m.media-amazon.com/images/I/51puNJL+mFL._AC_SL1500_.jpg",
"https://m.media-amazon.com/images/I/71SSt7gjQRL._AC_SL1500_.jpg",
"https://m.media-amazon.com/images/I/71Xpl2ZtisL._AC_SL1500_.jpg",
"https://m.media-amazon.com/images/I/71dyq7-erTL._AC_SL1500_.jpg",
"https://m.media-amazon.com/images/I/61oJ9W92AIL._AC_SL1500_.jpg",
"https://m.media-amazon.com/images/I/616eqgFk9JL._AC_SL1500_.jpg",
"https://m.media-amazon.com/images/I/61QKHhxdcnL._AC_SL1500_.jpg",
"https://m.media-amazon.com/images/I/51N7tlDow1L._AC_SL1500_.jpg"
],
"sellerFollow": 0,
"sellerId": "A32T2X8A81QU4X",
"sellerName": "FTDFITS",
"sellerType": "FBA",
"shipPrice": "FREE",
"stockState": 1,
"stockStr": "In Stock",
"subTitle": "Stainless Steel Wire Skimmer Spoon with Long Handle Asian Work Strainer Ladle for Kitchen Cooking and Frying",
"taskAsin": "B0CB3TJ46F",
"title": "RE0F10A RE0F10B JF011E Transmission Filter Oil Pan Gasket Kit 31728-1XF02"
}
Submit Keyword Task
Submit search keywords to collect the first 3 pages of the corresponding search results, including result ASIN rankings, sponsored ad placements and organic rankings. Note: the number of SP ads collected varies by account and environment.
https://ksicdata.com/api/addKeywordTask
Request Parameters
Body is a JSON array; batch submission supported, up to 2000 items per request.
| Parameter | Type | Required | Description |
|---|---|---|---|
keyword | string | Yes | Search keyword, e.g. ssd; must be shorter than 200 characters |
region | string | Yes | Marketplace code, e.g. us (keyword tasks are not supported for za) |
zipCode | string | Yes | Delivery postal code (required), used to simulate a local delivery address — see "Available Postal Codes" |
Request Example
[
{
"keyword": "ssd",
"region": "us",
"zipCode": "10001"
}
]
cURL Example (click to expand)
curl -X POST "https://ksicdata.com/api/addKeywordTask" \
-H "Content-Type: application/json" \
-H "ks-token: YOUR_TOKEN" \
-d '[
{
"keyword": "ssd",
"region": "us",
"zipCode": "10001"
}
]'
Response Example
{
"code": 0,
"msg": "请求成功",
"t": 1735891200000
}
Collected Data Sample (click to expand)
Sample data collected by addKeywordTask (search result page):
{
"brands": [
"Samsung",
"Sandisk",
"Kingston",
"PNY",
"Lexar",
"Crucial",
"Seagate",
"Patriot Memory",
"TEAMGROUP",
"Acer",
"Western Digital",
"fanxiang",
"Gigastone",
"KingSpec",
"OWC",
"Verbatim",
"Dell",
"SP Silicon Power",
"SSK",
"WD_BLACK",
"LaCie",
"Fikwot",
"ADATA",
"Intel",
"Corsair",
"ORICO",
"Transcend",
"ASUS",
"INLAND",
"Bestoss",
"Yottamaster",
"BIWIN",
"UGREEN",
"KEXIN",
"iDiskk",
"Oemgenuine",
"Water Panther",
"SUNEAST",
"MECCANIXITY",
"THREE COLOUR DOGFISH"
],
"data": [
{
"asin": "B09TVXVMVL",
"type": 3
},
{
"asin": "B0FFSWLYN6",
"type": 3
},
{
"asin": "B0BHJJ9Y77",
"bought": "6K+",
"type": 4
},
{
"asin": "B08HN37XC1",
"bought": "7K+",
"type": 5
},
{
"asin": "B0H6X892M7",
"bought": "",
"type": 6
},
{
"asin": "B0BHJF2VRN",
"bought": "4K+",
"type": 5
},
{
"asin": "B0B1H6NHWM",
"type": 3
},
{
"asin": "B0DX2DPJZ5",
"bought": "3K+",
"type": 6
},
{
"asin": "B08QB93S6R",
"bought": "1K+",
"type": 6
},
{
"asin": "B0H1NH99GX",
"bought": "1K+",
"type": 6
},
{
"asin": "B0DBR3DZWG",
"bought": "4K+",
"type": 6
},
{
"asin": "B0CX94D2YC",
"bought": "400+",
"type": 3
},
{
"asin": "B0DN7CYYSD",
"bought": "2K+",
"type": 6
},
{
"asin": "B0GMWYYRQL",
"bought": "3K+",
"type": 5
},
{
"asin": "B0CHFSWM2P",
"bought": "3K+",
"type": 6
},
{
"asin": "B07XZLN9KM",
"bought": "1K+",
"type": 6
},
{
"asin": "B0DL2ZW5Q5",
"type": 3
},
{
"asin": "B087K9L3R5",
"bought": "1K+",
"type": 6
},
{
"asin": "B0DX2G349M",
"bought": "1K+",
"type": 6
},
{
"asin": "B0874XWW23",
"bought": "1K+",
"type": 6
},
{
"asin": "B0874XN4D8",
"bought": "3K+",
"type": 6
},
{
"asin": "B0HCY57C89",
"bought": "100+",
"type": 3
}
],
"date": 1788933441091,
"keyword": "ssd",
"multiAdFeedback": [],
"otherSbInfo": [
{
"adId": "301302846015102",
"campaignId": "200082725590771",
"title": "fanxiang"
},
{
"adCreativeId": "0",
"adId": "301333305963202",
"advertiserIdNS": "axiom.ATVPDKIKX0DER.A2BOK2Y6E6BOLM",
"campaignId": "300046127002206",
"title": "Sandisk"
},
{
"adCreativeId": "0",
"adId": "301193262196402",
"advertiserIdNS": "axiom.ATVPDKIKX0DER.A34PF29WPO2NUY",
"campaignId": "200065924605171",
"title": "ORICO"
},
{
"adCreativeId": "0",
"adId": "300841565001702",
"advertiserIdNS": "axiom.ATVPDKIKX0DER.A307CH216CTGMP",
"campaignId": "300067183000406",
"title": "TerraMaster"
}
],
"page": 1,
"pageSize": 16,
"relatedSearches": [
"ssd 2tb",
"pc case",
"ram",
"ssd m.2",
"eptwfu01",
"w10295370a water filter"
],
"sbInfo": [
{
"asins": [
"B0CM8W1S8K",
"B0CM63ZP2Y",
"B0CM8M8293",
"B0CM8QWND1",
"B0CM396BR5"
],
"info": [
{
"adId": "301302846015102",
"campaignId": "200082725590771",
"title": "fanxiang"
}
]
}
],
"sbvProduct": [
{
"adId": "301199430453502",
"advertiserId": "1180265711302",
"asins": [
"B0DX2G349M",
"B0DX2DPJZ5",
"B0DX2GJ1YR",
"B0DX2G349M",
"B0DX2DPJZ5",
"B0DX2GJ1YR"
],
"campaignId": "200066018753971",
"clientId": "1146297-2425835-3050475",
"marketplaceId": "ATVPDKIKX0DER",
"pageNumber": "1",
"pageType": "Search",
"searchQuery": "ssd",
"videoSrc": "https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/be609b97-5adf-4991-a0b6-e0b24de24674.mp4/productVideoOptimized.mp4",
"widgetType": "video-product-collection"
}
],
"sbvSingleProductList": [
{
"adId": "301481935525902",
"advertiserId": "28478593802",
"asin": "B0BNB5VJYM",
"campaignId": "200107483698171",
"deviceOs": "unrecognized",
"language": "en_US",
"marketplaceId": "ATVPDKIKX0DER",
"pageNumber": "1",
"pageType": "Search",
"searchQuery": "ssd",
"videoSrc": "https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/6a87dee6-ca4e-4321-ade4-11e35c8498aa.mp4/productVideoOptimized.mp4",
"videoType": "sponsored",
"widgetIndex": "19",
"widgetType": "SINGLEPRODUCT"
},
{
"adId": "301328770019902",
"advertiserId": "459662793602",
"asin": "B0CX94D2YC",
"campaignId": "200089582583671",
"deviceOs": "unrecognized",
"language": "en_US",
"marketplaceId": "ATVPDKIKX0DER",
"pageNumber": "1",
"pageType": "Search",
"searchQuery": "ssd",
"videoSrc": "https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/feed6299-8874-45c6-b635-148adfd41fb7.mp4/productVideoOptimized.mp4",
"videoType": "sponsored",
"widgetIndex": "31",
"widgetType": "SINGLEPRODUCT"
}
],
"sellers": [
{
"id": "AZFWA4N8RPTV7",
"name": "ZAR Systems Germany"
},
{
"id": "A27S8ZOPVER272",
"name": "ArchMemory"
},
{
"id": "ATVPDKIKX0DER",
"name": "Amazon.com"
},
{
"id": "AE3YR9AX5P25J",
"name": "CorteseInc"
},
{
"id": "A3VDZYEX6FFODH",
"name": "COMP XP"
},
{
"id": "A73D0XU1SPJHU",
"name": "Neutron USA"
},
{
"id": "A2DKF1L73WUF4Q",
"name": "Amazon Germany"
}
],
"spProduct": [
{
"asin": "B09TVXVMVL",
"info": {
"widgetName": "sp_atf",
"adId": "301470447530102",
"adIndex": "0",
"qualifier": "1788933443",
"id": "1494849547532381",
"eventType": "1"
}
},
{
"asin": "B0FFSWLYN6",
"info": {
"widgetName": "sp_atf",
"adId": "301126744974302",
"adIndex": "1",
"qualifier": "1788933443",
"id": "1494849547532381",
"eventType": "1"
}
},
{
"asin": "B0B1H6NHWM",
"info": {
"widgetName": "sp_mtf",
"adId": "301497767313502",
"adIndex": "2",
"qualifier": "1788933443",
"id": "1494849547532381",
"eventType": "1"
}
},
{
"asin": "B0CX94D2YC",
"info": {
"widgetName": "sp_mtf",
"adId": "301276315635102",
"adIndex": "3",
"qualifier": "1788933443",
"id": "1494849547532381",
"eventType": "1"
}
},
{
"asin": "B0DL2ZW5Q5",
"info": {
"widgetName": "sp_mtf",
"adId": "300625208096702",
"adIndex": "4",
"qualifier": "1788933443",
"id": "1494849547532381",
"eventType": "1"
}
},
{
"asin": "B0HCY57C89",
"info": {
"widgetName": "sp_btf",
"adId": "301437404963002",
"adIndex": "5",
"qualifier": "1788933443",
"id": "1494849547532381",
"eventType": "1"
}
}
],
"total": 35114
}
Submit BSR List Task
Submit a BSR list URL to collect the top 100 products of that list. type: 1 = Best Sellers (BSR), 2 = New Releases.
https://ksicdata.com/api/addBsr100Task
Request Parameters
Body is a JSON array; batch submission supported, up to 2000 items per request.
| Parameter | Type | Required | Description |
|---|---|---|---|
suffixUrl | string | Yes | Full list page URL (domain included). Any parameters after ? are stripped by the server — see the examples below |
type | string | Yes | List type: 1 = BSR Best Sellers, 2 = New Releases |
region | string | Yes | Marketplace code, e.g. us — see "Supported Marketplaces" |
zipCode | string | Yes | Delivery postal code (required), used to simulate a local delivery address — see "Available Postal Codes" |
suffixUrl Examples
https://www.amazon.com/Best-Sellers-Baby-Baby-Care-Products/zgbs/baby-products/17720255011/ref=zg_bs_nav_baby-products_1
https://www.amazon.com/gp/new-releases/baby-products/166863011/ref=zg_bsnr_pg_2_baby-products?ie=UTF8&pg=2
suffixUrl must be the full URL including the domain; any parameters after ? will be removed by the server.
Request Example
[
{
"suffixUrl": "https://www.amazon.com/gp/new-releases/baby-products/166863011/ref=zg_bsnr_pg_2_baby-products?ie=UTF8&pg=2",
"region": "us",
"zipCode": "10001",
"type": "2"
}
]
cURL Example (click to expand)
curl -X POST "https://ksicdata.com/api/addBsr100Task" \
-H "Content-Type: application/json" \
-H "ks-token: YOUR_TOKEN" \
-d '[
{
"suffixUrl": "https://www.amazon.com/gp/new-releases/baby-products/166863011/ref=zg_bsnr_pg_2_baby-products?ie=UTF8&pg=2",
"region": "us",
"zipCode": "10001",
"type": "2"
}
]'
Response Example
{
"code": 0,
"msg": "请求成功",
"t": 1735891200000
}
Collected Data Sample (click to expand)
Sample data collected by addBsr100Task (list ASINs — see "BSR List Field Reference" in the appendix):
{
"asins": [
"B0H7J36CWB",
"B0HGFSZ1NF",
"B0GQS8C35N",
"B0HBLYJ8QS",
"B0H6L2CC95",
"B0H947W4TN",
"B0H6SHHJ2K",
"B0HB3VVH2D",
"B0H9YN1T4V",
"B0H6WKFYBL",
"B0H2YZ9J13",
"B0H7TP8RZF",
"B0H5BR6R7Z",
"B0H1L84XQM",
"B0H4TC6CMQ",
"B0GY8H621F",
"B0HC6KLZ82",
"B0H8CP1Z8S",
"B0HBBBQP8F",
"B0H9R9TKHQ",
"B0HBBKQLGD",
"B0HHNH7DYQ",
"B0GXVLBMSM",
"B0H7BMS3HJ",
"B0HB4G8H66",
"B0HBBV1GZ4",
"B0H6FSZD6H",
"B0H58SZNZJ",
"B0H7JLCVNC",
"B0H5BVHCTG",
"B0HG9SF4ZX",
"B0HDHMQFGZ",
"B0H2DND3GC",
"B0H4C4B3R7",
"B0H32KTRDX",
"B0H417NZQD",
"B0H8MYZ4LV",
"B0H69633K1",
"B0H1D27V2F",
"B0HC6J5VSS",
"B0H7RQG6M9",
"B0HCBMH9CF",
"B0H5RGSZSZ",
"B0H9493P6L",
"B0HD718DYJ",
"B0H5W1BR3Z",
"B0H837ND2M",
"B0HC6JDYKZ",
"B0H3F5MTP7",
"B0GZWLWVXB"
],
"page": 2,
"region": "us",
"type": "NEW_RELEASE_TOP100",
"url": "https://www.amazon.com/gp/new-releases/baby-products/166863011/ref=zg_bsnr_pg_2_baby-products"
}
Submit Category Top 400 Task
Submit a category node to collect its list pages, extracting the ASINs from each page. Use page to specify how many pages to collect (max 400, defaults to 400).
https://ksicdata.com/api/addCategory400Task
Request Parameters
Body is a JSON array; batch submission supported, up to 2000 items per request.
| Parameter | Type | Required | Description |
|---|---|---|---|
nodeId | string | Yes | Category node ID, e.g. 17720255011 |
page | integer | No | Number of pages to collect, max 400; defaults to 400 if omitted |
region | string | Yes | Marketplace code, e.g. us — see "Supported Marketplaces" |
zipCode | string | Yes | Delivery postal code (required), used to simulate a local delivery address — see "Available Postal Codes" |
Request Example
[
{
"nodeId": "17720255011",
"page": 400,
"region": "us",
"zipCode": "10001"
}
]
cURL Example (click to expand)
curl -X POST "https://ksicdata.com/api/addCategory400Task" \
-H "Content-Type: application/json" \
-H "ks-token: YOUR_TOKEN" \
-d '[
{
"nodeId": "17720255011",
"page": 400,
"region": "us",
"zipCode": "10001"
}
]'
Response Example
{
"code": 0,
"msg": "请求成功",
"t": 1735891200000
}
Collected Data Sample (click to expand)
Sample data collected by addCategory400Task (category list ASINs — see "Category Top 400 Field Reference" in the appendix):
{
"asins": [
"B0D14Y57K7",
"B0DKKVRHK9",
"B0DPNC61JZ",
"B0CH1NYCV1",
"B0DYTZP95B",
"B0CB5BX8JK",
"B0CSTFLRK4",
"B0D2JL223K",
"B0D2TZYMQG",
"B0DQKPZ79M",
"B0DYHGKF9Q",
"B0F3JC4GWM",
"B0FP2DDJ2V",
"B0FBXN44KM",
"B0CNCVSKWJ",
"B0GJV2JKN5",
"B0FHB9B53J",
"B0CFVF8P2Q",
"B0CDGW4Y46",
"B0CLTK8QC1",
"B0CW2Q38ZD",
"B0FXGTGQG7",
"B0CSXWXSR6",
"B0BRC5GF19"
],
"nodeId": "17720255011",
"page": 5,
"region": "us",
"type": "BSR"
}
Submit Seller Store Task
Submit a seller ID to collect the store information on the seller store page, such as rating scores, store address, store introduction and business name. Note: some marketplaces (e.g. Canada ca) do not display the store address.
https://ksicdata.com/api/addSellerTask
Request Parameters
Body is a JSON array; batch submission supported, up to 2000 items per request.
| Parameter | Type | Required | Description |
|---|---|---|---|
sellerId | string | Yes | Seller ID, e.g. A1738THC4GAJK2 |
region | string | Yes | Marketplace code, e.g. us — see "Supported Marketplaces" |
zipCode | string | Yes | Delivery postal code (required), used to simulate a local delivery address — see "Available Postal Codes" |
Request Example
[
{
"sellerId": "A1738THC4GAJK2",
"region": "us",
"zipCode": "10001"
}
]
cURL Example (click to expand)
curl -X POST "https://ksicdata.com/api/addSellerTask" \
-H "Content-Type: application/json" \
-H "ks-token: YOUR_TOKEN" \
-d '[
{
"sellerId": "A1738THC4GAJK2",
"region": "us",
"zipCode": "10001"
}
]'
Response Example
{
"code": 0,
"msg": "请求成功",
"t": 1735891200000
}
Collected Data Sample (click to expand)
Sample data collected by addSellerTask (store information — see "Seller Store Field Reference" in the appendix):
{
"address": [
"FLAT C 9/F WINNING HOUSE",
"72-74 WING LOK ST",
"SHEUNG WAN HK",
"HK",
"999077",
"HK"
],
"businessName": "CGR TRADING COMPANY LIMITED",
"ratingCount": [
"{\"star2Count\":0,\"star5Count\":8,\"ratingCountWithText\":9,\"star4\":0,\"star5\":89,\"star5CountWithText\":8,\"star2\":0,\"star3Count\":0,\"star1Count\":1,\"star3\":0,\"ratingCount\":9,\"star1\":11,\"star4Count\":0,\"star4CountWithText\":0,\"star3CountWithText\":0,\"star1CountWithText\":1,\"star2CountWithText\":0}",
"{\"star2Count\":0,\"star5Count\":25,\"ratingCountWithText\":28,\"star4\":4,\"star5\":89,\"star5CountWithText\":25,\"star2\":0,\"star3Count\":0,\"star1Count\":2,\"star3\":0,\"ratingCount\":28,\"star1\":7,\"star4Count\":1,\"star4CountWithText\":1,\"star3CountWithText\":0,\"star1CountWithText\":2,\"star2CountWithText\":0}",
"{\"star2Count\":2,\"star5Count\":124,\"ratingCountWithText\":137,\"star4\":3,\"star5\":91,\"star5CountWithText\":124,\"star2\":1,\"star3Count\":1,\"star1Count\":6,\"star3\":1,\"ratingCount\":137,\"star1\":4,\"star4Count\":4,\"star4CountWithText\":4,\"star3CountWithText\":1,\"star1CountWithText\":6,\"star2CountWithText\":2}",
"{\"star2Count\":10,\"star5Count\":570,\"ratingCountWithText\":673,\"star4\":6,\"star5\":85,\"star5CountWithText\":569,\"star2\":1,\"star3Count\":16,\"star1Count\":40,\"star3\":2,\"ratingCount\":674,\"star1\":6,\"star4Count\":38,\"star4CountWithText\":38,\"star3CountWithText\":16,\"star1CountWithText\":40,\"star2CountWithText\":10}"
],
"ratingNumber": [
"4.6",
"4.7",
"4.7",
"4.6"
],
"region": "us",
"sellerId": "A1738THC4GAJK2",
"sellerName": "CGR-Leo"
}
Submit Seller ASIN Task
Submit a seller ID to collect the ASIN list of the seller's store — useful for monitoring new store listings. If page is omitted, all ASINs of the store are collected.
https://ksicdata.com/api/addSellerAsinTask
Request Parameters
Body is a JSON array; batch submission supported, up to 2000 items per request.
| Parameter | Type | Required | Description |
|---|---|---|---|
sellerId | string | Yes | Seller ID, e.g. A2RJLAGU2HCBYM |
page | integer | No | Number of pages to collect. If omitted, all ASINs of the store are collected, up to 1000 pages |
region | string | Yes | Marketplace code, e.g. us — see "Supported Marketplaces" |
zipCode | string | Yes | Delivery postal code (required), used to simulate a local delivery address — see "Available Postal Codes" |
Request Example
[
{
"sellerId": "A2RJLAGU2HCBYM",
"region": "us",
"zipCode": "10001"
}
]
cURL Example (click to expand)
curl -X POST "https://ksicdata.com/api/addSellerAsinTask" \
-H "Content-Type: application/json" \
-H "ks-token: YOUR_TOKEN" \
-d '[
{
"sellerId": "A2RJLAGU2HCBYM",
"region": "us",
"zipCode": "10001"
}
]'
Response Example
{
"code": 0,
"msg": "请求成功",
"t": 1735891200000
}
Collected Data Sample (click to expand)
Sample data collected by addSellerAsinTask (store ASIN list — see "Seller ASIN Field Reference" in the appendix):
{
"asins": [
"B0GHR4CFKQ",
"B0GGQHMM1K",
"B0GGQQ5BJQ",
"B0GFCWM8Q9",
"B0FZKR62Y4",
"B0FSJP3H7V",
"B0FQBNJC51",
"B0FQBLKYM4",
"B0FY2T81M6",
"B0FQBGD4S5",
"B0FQBH846Q",
"B0FL6ZXWYC",
"B0FH6Y2P59",
"B0FJBQ5ZWS",
"B0FJD3B7W6",
"B0DYP5N8VQ"
],
"page": 2,
"region": "us",
"sellerId": "A2RJLAGU2HCBYM",
"userId": "1"
}
Error Codes
The code field in the response body carries the status. Any value other than 0 means failure:
| Code | Description |
|---|---|
0 | Success |
1 | Request error |
401 | Unauthorized (token missing, invalid or expired) |
503 | Server under maintenance (usually starts after 11 PM and finishes within 20 minutes) |
10001 | Missing parameters |
10002 | Batch limit exceeded (max 2000 items per request) |
10003 | Keyword too long |
10004 | Invalid postal code |
10005 | Marketplace not supported |
Supported Marketplaces
Valid values for the region field — 23 marketplaces in total:
| Code | Country / Region | Domain |
|---|---|---|
us | United States | amazon.com |
de | Germany | amazon.de |
ca | Canada | amazon.ca |
uk | United Kingdom | amazon.co.uk |
es | Spain | amazon.es |
it | Italy | amazon.it |
mx | Mexico | amazon.com.mx |
in | India | amazon.in |
fr | France | amazon.fr |
jp | Japan | amazon.co.jp |
br | Brazil | amazon.com.br |
ae | UAE | amazon.ae |
au | Australia | amazon.com.au |
eg | Egypt | amazon.eg |
sa | Saudi Arabia | amazon.sa |
nl | Netherlands | amazon.nl |
se | Sweden | amazon.se |
pl | Poland | amazon.pl |
be | Belgium | amazon.com.be |
ie | Ireland | amazon.ie |
sg | Singapore | amazon.sg |
tr | Turkey | amazon.com.tr |
za | South Africa | amazon.co.za |
za).
Available Postal Codes
Postal codes supported for each marketplace — use these values for the zipCode field:
| Marketplace | Postal Code | City |
|---|---|---|
us | 90001 | 洛杉矶 |
us | 10001 | 纽约 |
us | 60601 | 芝加哥 |
us | 84104 | 盐湖城 |
de | 10115 | 柏林 |
de | 20095 | 汉堡 |
de | 80331 | 慕尼黑 |
jp | 162-0802 | 东京 新宿区 |
jp | 060-0807 | 北海道 札幌市 |
jp | 604-8153 | 京都市中京区 |
jp | 541-0056 | 大阪市中央区 |
uk | W1S 3PR | 伦敦 |
uk | B2 4QA | 伯明翰 |
uk | M1 2AR | 曼彻斯特 |
es | 28001 | 马德里 |
es | 08001 | 巴塞罗那 |
es | 46001 | 瓦伦西亚 |
es | 41001 | 塞维利亚 |
it | 00118 | 罗马 |
it | 20121 | 米兰 |
it | 80100 | 那不勒斯 |
ca | M5S 1A1 | 多伦多 |
ca | K1A 7P8 | 渥太华 |
ca | H2T 2A4 | 蒙特利尔 |
ca | V5Z 3N5 | 温哥华 |
fr | 75001 | 巴黎 |
fr | 13001 | 马赛 |
fr | 69001 | 里昂 |
mx | 11000 | 墨西哥城 |
mx | 44100 | 瓜达拉哈拉 |
in | 400001 | 孟买 |
in | 110001 | 新德里 |
br | 01319-010 | 圣保罗 |
br | 20010-000 | 里约热内卢 |
au | 2000 | 悉尼 |
ae | Dubai | 迪拜 |
eg | القاهرة | 开罗 |
sa | الرياض | 利雅得 |
nl | 1079 | 阿姆斯特丹 |
se | 111 64 | 斯德哥尔摩 |
pl | 00-277 | 华沙 |
be | 1050 | 布鲁塞尔 |
ie | D04 K6F2 | 都柏林 |
sg | 048616 | 莱佛士 |
tr | 34912 | 伊斯坦布尔省 |
za | 2196 | 约翰内斯堡 |
ASIN Field Reference (addAsinTask)
Field reference for addAsinTask collected data (from the original product doc). Click a screenshot to enlarge.
| Field | Name | Type | Example | Screenshot | Remark |
|---|---|---|---|---|---|
asin | asin | String | B0BZZDPPRX | asin字段默认就是客户的任务asin,如果页面有currentAsin就拿currentAsin来覆盖asin字段 url访问的的是B0G92ZGB47 ,页面跳转后链接asin变成了 B0G93BYSLX | |
parentAsin | 父asin | String | B0CJDQJCJV | 不一定有 | |
brandName | 品牌名称 | String | |||
brandId | 品牌id | String | F3FCA711-BFF5-47D1-AF38-D1BE5481408E | ||
ratings | 评分 | Double | 4.3 | ||
reviews | 评论数 | Integer | |||
title | 标题 | String | |||
mainImage | 主图 | String | |||
secondaryImage | 副图 | List<String> | |||
video | 视频地址 | String | |||
price | 价格 | Double | |||
buybox | 购物车价格 | Double | |||
sellerName | 卖家名称 | String | |||
sellerId | 卖家id | String | A2OH0FV1GVQLHQ | ||
sellerFollow | 跟卖数量 | Integer | |||
fivePoint | 五点 | List<String> | |||
firstAvailable | 上架日期 | String | |||
firstDate | 上架日期 时间戳格式 | Date | 1586880000000 | ||
mainRank | 大类信息 | Object | { "rank": 62, "rankName": "Tools & Home Improvement" } | 大类与左上角类目不一定一致,所以不返回nodeId,需要自行维护大类的名称对应的id | |
nodeNames | 分类目录 | List<String> | |||
nodeIds | 分类目录id | List<String> | |||
variantAsin | 变体asin | List<Object> | [ { "asin": "B07GBNDTQB", "style": [ "7.5", "Dar… | ||
bs | 是否为bestsellers | Boolean | |||
ac | 是否为Amazon's Choice | Boolean | |||
newReleases | 是否为new Releases | Boolean | |||
climatePledgeFriendly | 是否为气候友好 | Boolean | |||
productDocuments | 是否有产品文档 | Boolean | |||
description | 描述 | String | 产品文字描述,如果有A+,那就可能没描述 | ||
aplus | 是否有A+ | Boolean | 一堆图文介绍产品,一般都有 | ||
date | 数据采集日期 | Date | 采集时的时间戳 | ||
dimensions | 尺寸 | dimensions | |||
listPrice | 划线价 | Double | |||
relateMap | 有关联的asin | Object | { "Products related to this item": [ "B07TRT7NR6", "B0BGL1F88Y",… | Frequently bought together,Customers also bought,Compare with similar items 等相关的asin | |
otherRanks | 小类排名 | List<Object> | [ { "nodeId": "360472031", "rank": 1518, … | ||
bought | 月销量 | String | |||
deal | 折扣 | Double | |||
coupon | 优惠券 | String | |||
primePrice | prime价格 | Double | |||
featureNames | 产品信息名称 | List<String> | |||
featureValues | 产品信息值 | List<String> | |||
variationsNames | 变体名称 | List<String> | [ "Size", "Color" ] | 对应variantAsin字段里的style信息 | |
productInformation | 产品信息 | List<Object> | [ { "name": "Brand", "value": "Hefty" }, { "name":… | asin:B097F7XJM1,productInformation和productDetails一般只存在一个 | |
productDetails | 产品信息 | List<Object> | asin:B0B3HLLC4L,productInformation和productDetails一般只存在一个 | ||
offerDisplays | 发货信息 | List<Object> | |||
topBrand | 大品牌标志 | String | |||
stockState | 库存情况 | Integer | -1:未知 1:In Stock 2:Only 5 left in stock - order soon. 3:Currently unavailable. 4: asin已下架,404 | ||
stockStr | 库存情况描述 | String | In Stock或者Only 5 left in stock - order soon.之类 | ||
customersAspects | 评论标签 | List<String> | |||
customersSay | 评论概述 | String | |||
newerModel | newerModel asin | String | 位于主图下方 | ||
similarItem | newerModel asin | String | 位于五点 下方 | ||
sellerType | 卖家类型 | String | FBA: “Ships from 是亚马逊 ,sold by 不是亚马逊” FBM: “Ships from 和 sold by 都不是亚马逊” … | ||
shipPrice | 运费 | String | $8.98 或者 FREE或者空字符 | ||
taskAsin | 任务asin | String | B0G92ZGB47 | 客户发过来要采集的asin | |
currency | 货币 | String | |||
newOnAmz | 是否最近一个月上架 | Boolean | false | ||
bundleItems | 一起售卖 | List<String> | ["B0CQ7WZBJ2","B09M8NTXMG"] | ||
subTitle | 子标题 | String | Stainless Steel Wire Skimmer Spoon with Long Handle… |
Keyword Field Reference (addKeywordTask)
Field reference for addKeywordTask collected data (from the original product doc). Click a screenshot to enlarge.
| Field | Name | Type | Example | Screenshot | Remark |
|---|---|---|---|---|---|
keyword | 关键词 | String | ssd | ||
page | 第几页 | Integer | 1 | ||
total | 商品总数 | Integer | |||
pageSize | 一页有多少个自然asin | Integer | |||
date | 数据采集日期 | Date | 时间戳 | ||
sbInfo | sb广告信息 | List<Object> | { "asins": [ "B0DHLCRF91", "B08QBL36… | ||
otherSbInfo | 搜索页底部品牌广告 | List<Object> | [ { "adId": "300458182627102", "adCr… | ||
data | asin数据 | List<Object> | [{ "bought": "100+ bought in past month", "asin": "B089C3TZL9", … | type类型, 3:SP,4:AC,5:BS,6:NATURE | |
multiAdFeedback | 搜索页中部横幅广告数据 | List<Object> | [ { "adId": "A03719253UPU4SBHUAW8M", … | 还有Customers frequently viewed ,4 stars and above,Picks from Amazon Influencers等 | |
sbvSingleProductList | 视频广告的asin信息 | List<Object> | [ { "pageNumber": "1", "campaignId":… | 单asin的,通常位于底部 | |
sbvProduct | 视频广告的asin信息 | List<Object> | { "asins": [ "B0CYR5L92K", "B0DKG8G5J3" ], "ma… | 多asin的 | |
spProduct | sp广告的asin信息 | List<Object> | [ { "asin": "B0CXPVGHQH", "info": { … | ||
relatedSearches | 相关搜索 | List<String> | [ "ssd 2tb", "pc case", "ram", "… | ||
brands | 左侧品牌 | List<String> | [ "Samsung", "Crucial", "WD_BLACK", … | ||
sellers | 左侧卖家 | List<Object> | [ { "name": "USA BUY", "id": "AQE66… |
BSR List Field Reference (addBsr100Task)
Fields returned by addBsr100Task:
| Field | Name | Type | Description |
|---|---|---|---|
asins | ASIN 列表 | List<String> | 页面采集到的 asin,顺序即排名顺序;第二页则从第 51 名开始 |
page | 页码 | Integer | 1 或 2 |
region | 国家 | String | 站点代码,如 us |
type | 榜单类型 | String | NEW_RELEASE_TOP100 或 BSR_TOP100 |
url | 榜单链接 | String | 返回用户传入的 url(问号 ? 之后的参数已去除),方便判断任务来源 |
Category Top 400 Field Reference (addCategory400Task)
Fields returned by addCategory400Task:
| Field | Name | Type | Description |
|---|---|---|---|
asins | ASIN 列表 | List<String> | 页面采集到的 asin,顺序为页面 asin 展示的顺序 |
page | 页码 | Integer | 1 ~ 400 |
nodeId | 类目节点 ID | String | 传入的 nodeId |
region | 国家 | String | 站点代码,如 us |
type | 榜单类型 | String | 固定为 BSR |
Seller Store Field Reference (addSellerTask)
Fields returned by addSellerTask:
| Field | Name | Type | Description |
|---|---|---|---|
address | 地址 | List<String> | 店铺地址(部分站点如加拿大不返回) |
businessName | 名称 | String | 公司名称 |
ratingCount | 各个评分数量 | List<String> | 各个评分的数量(JSON 字符串) |
ratingNumber | 打分情况 | List<String> | 1 月内、3 月内、12 月内、开店以来的打分情况 |
region | 国家 | String | 站点代码,如 us |
sellerId | 卖家 ID | String | 卖家 id |
sellerName | 卖家名称 | String | 卖家名称 |
Seller ASIN Field Reference (addSellerAsinTask)
Fields returned by addSellerAsinTask:
| Field | Name | Type | Description |
|---|---|---|---|
asins | ASIN 列表 | List<String> | 页面采集到的 asin,顺序为页面展示顺序,越靠前上架日期越新 |
page | 页码 | Integer | 页码 |
region | 国家 | String | 站点代码,如 us |
sellerId | 卖家 ID | String | 卖家 id |