DataBlue / Docs / Endpoint
POST/v1/data/amazon/scrape
Amazon Full Scrape
Run a combined Amazon scrape that can return product listings, brand-store SKUs, A+ content, review previews, ranking rows, and media metadata from one public endpoint. Small listing/ranking requests complete inline; deeper product, store, media, A+, reviews, and high-volume requests are queued automatically and return a job URL to poll.
Execution Model
Live request
Runtime depends on endpoint, target, pagination, rendering mode, and active plan limits.
Credit Weight
Live catalog
Current weights are managed from the Data API Weights admin table and shown on pricing before use.
Parameters
| Name | Type | Requirement | Description |
|---|---|---|---|
| query | string | optional | Amazon product search query. Required unless url, start_urls, or asin is supplied. |
| url | string | optional | Amazon search, category, brand-store, or product URL. |
| start_urls | string[] | optional | Actor-compatible list of Amazon URLs to scrape. |
| categoryOrProductUrls | string[] | object[] | optional | Actor-compatible alias for start_urls. Objects with a url property are accepted. |
| asin | string | optional | Direct Amazon product ASIN. |
| modules | string[] | optional | Modules to return: products, store, a_plus, reviews, rankings, media. |
| num_results / maxItemsPerStartUrl | number | optional | Maximum products to fetch (1-960). |
| page | number | optional | Starting Amazon listing page (1-20). |
| page_limit / maxSearchPagesPerStartUrl | number | optional | Maximum Amazon listing pages to fetch (1-20). |
| domain | string | optional | Amazon domain, e.g. amazon.in, amazon.com, amazon.co.uk, amazon.de. |
| country / countryCode | string | optional | Two-letter delivery or marketplace country code. |
| postal_code / zipCode | string | optional | Delivery postal or ZIP code. |
| sort_by | string | optional | Sort order: relevance, price_low, price_high, rating, newest. |
| min_price | number | optional | Minimum price filter in whole currency units. |
| max_price | number | optional | Maximum price filter in whole currency units. |
| prime_only | boolean | optional | Filter to Prime-eligible products when Amazon supports the filter. |
| language | string | optional | Language code. |
| detail_level / scrapeProductDetails | string | boolean | optional | listing for fast rows, full or scrapeProductDetails=true for product-detail enrichment. |
| include_product_details | boolean | optional | Force product detail enrichment for selected rows. |
| include_offers / maxOffers | boolean | number | optional | Include offer listing data when available. maxOffers also enables offers. |
| max_offers | number | optional | Maximum offers to include per product (0-20). |
| include_sellers / scrapeSellers | boolean | optional | Include seller details when available. |
| include_variants / scrapeProductVariantPrices | boolean | optional | Include variant ASINs/prices when available. |
| include_reviews_preview / includeReviewsPreview | boolean | optional | Include review snippets when available. |
| reviews_limit | number | optional | Maximum review snippets inside the reviews module (1-50). |
Response Fields
| Field | Type | Description |
|---|---|---|
| success | boolean | Whether the inline request completed or the queued job was accepted. |
| status | string | completed, failed, or queued. |
| platform / operation | string | Static identifiers: amazon and scrape. |
| modules | string[] | Normalized module list used for the request. |
| data.products | array | Amazon product rows with ASIN, title, URL, images, price, rating, review count, badges, delivery, seller, details, variants, offers, and reviews preview when available. |
| data.store | object | Brand-store URL, total_skus, pages_fetched, skus, products, and metadata when store is requested. |
| data.a_plus | object | Parsed A+ content, brand story, and enriched product when a_plus is requested. |
| data.reviews | object | Review preview rows and product rating metadata when reviews is requested. |
| data.rankings | object | Ranked listing rows for search/category analysis when rankings is requested. |
| data.media | object | Images, gallery images, high-resolution images, videos_count, and video_types when media is requested. |
| job_id | string | Queued job id when DataBlue returns HTTP 202. |
| status_url | string | Polling URL for queued full-scrape jobs. |
| polling | object | Recommended polling interval and max wait for queued jobs. |
| credits_used / credits_reserved | number | Credit count for completed inline runs or reserved credits for queued runs. |
| time_taken | number | Inline request time in seconds when completed immediately. |
| error | string | Error message for failed requests. |
cURL Example
curl -X POST "https://api.datablue.dev/v1/data/amazon/scrape" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"url": "https://www.amazon.in/stores/page/02D3EE5F-D59D-4010-B7E4-5F106ED3F47B/",
"modules": [
"products",
"store",
"a_plus",
"reviews",
"rankings",
"media"
],
"num_results": 20,
"domain": "amazon.in",
"countryCode": "IN",
"zipCode": "560034",
"scrapeProductDetails": true,
"includeReviewsPreview": true,
"reviews_limit": 10
}'System Responses
200 OK
Request processed successfully.
401 UNAUTHORIZED
Missing or invalid API key.
429 RATE LIMIT
System capacity exceeded.
500 SYSTEM FAILURE
Internal core exception.
EXAMPLE RESPONSE
{
"success": true,
"status": "queued",
"platform": "amazon",
"operation": "scrape",
"modules": [
"products",
"store",
"a_plus",
"reviews",
"rankings",
"media"
],
"job_id": "3f7e2f6c-7a7d-4d16-9f5d-f9c4c7292a11",
"status_url": "/v1/data/jobs/3f7e2f6c-7a7d-4d16-9f5d-f9c4c7292a11",
"polling": {
"interval_seconds": 5,
"max_wait_seconds": 900
},
"credits_reserved": 12
}