Docs / API reference

POST/v1/data/amazon/scrape

Amazon Full Scrape

Collect selected Amazon product, store, A+, review, ranking, and media modules.

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.

Amazon Full Scrape Endpoint

Select Amazon data modules in one request; deeper work may continue as a job.

Getting Started

Send your API key as a bearer token. Start with the smallest request below.

Collect Product Listings

Start with the products module and a small result limit.

curl -X POST "https://api.datablue.dev/v1/data/amazon/scrape" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "query": "wireless headphones",
  "modules": [
    "products"
  ],
  "num_results": 20
}'
Example response
{
  "success": true,
  "status": "queued",
  "platform": "amazon",
  "operation": "scrape",
  "modules": [
    "products"
  ],
  "job_id": "3f7e2f6c-7a7d-4d16-9f5d-f9c4c7292a11",
  "status_url": "/v1/data/jobs/3f7e2f6c-7a7d-4d16-9f5d-f9c4c7292a11",
  "credits_reserved": 12
}

Amazon Sources

Use a URL

Send a search, category, store, or product URL.

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/s?k=wireless+headphones",
  "modules": [
    "products"
  ]
}'
Example response
{
  "success": true,
  "status": "queued",
  "platform": "amazon",
  "operation": "scrape",
  "modules": [
    "products"
  ],
  "job_id": "3f7e2f6c-7a7d-4d16-9f5d-f9c4c7292a11",
  "status_url": "/v1/data/jobs/3f7e2f6c-7a7d-4d16-9f5d-f9c4c7292a11",
  "credits_reserved": 12
}

Use Native URL Lists

Send start_urls for a bounded list of Amazon sources.

curl -X POST "https://api.datablue.dev/v1/data/amazon/scrape" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "start_urls": [
    "https://www.amazon.in/s?k=wireless+headphones"
  ],
  "modules": [
    "products"
  ]
}'
Example response
{
  "success": true,
  "status": "queued",
  "platform": "amazon",
  "operation": "scrape",
  "modules": [
    "products"
  ],
  "job_id": "3f7e2f6c-7a7d-4d16-9f5d-f9c4c7292a11",
  "status_url": "/v1/data/jobs/3f7e2f6c-7a7d-4d16-9f5d-f9c4c7292a11",
  "credits_reserved": 12
}

Use Actor-Compatible URL Lists

Use categoryOrProductUrls when migrating an actor-style payload.

curl -X POST "https://api.datablue.dev/v1/data/amazon/scrape" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "categoryOrProductUrls": [
    {
      "url": "https://www.amazon.in/gp/bestsellers/electronics"
    }
  ],
  "modules": [
    "products"
  ]
}'
Example response
{
  "success": true,
  "status": "queued",
  "platform": "amazon",
  "operation": "scrape",
  "modules": [
    "products"
  ],
  "job_id": "3f7e2f6c-7a7d-4d16-9f5d-f9c4c7292a11",
  "status_url": "/v1/data/jobs/3f7e2f6c-7a7d-4d16-9f5d-f9c4c7292a11",
  "credits_reserved": 12
}

Use an ASIN

Send one ASIN for product-specific modules.

curl -X POST "https://api.datablue.dev/v1/data/amazon/scrape" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "asin": "B0EXAMPLE1",
  "modules": [
    "products",
    "a_plus",
    "reviews",
    "media"
  ]
}'
Example response
{
  "success": true,
  "status": "queued",
  "platform": "amazon",
  "operation": "scrape",
  "modules": [
    "products"
  ],
  "job_id": "3f7e2f6c-7a7d-4d16-9f5d-f9c4c7292a11",
  "status_url": "/v1/data/jobs/3f7e2f6c-7a7d-4d16-9f5d-f9c4c7292a11",
  "credits_reserved": 12
}

Modules

Select Data Modules

Choose products, store, A+, reviews, rankings, and media as needed.

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/EXAMPLE",
  "modules": [
    "products",
    "store",
    "a_plus",
    "reviews",
    "rankings",
    "media"
  ],
  "include_product_details": true,
  "reviews_limit": 8
}'
Example response
{
  "success": true,
  "status": "queued",
  "platform": "amazon",
  "operation": "scrape",
  "modules": [
    "products"
  ],
  "job_id": "3f7e2f6c-7a7d-4d16-9f5d-f9c4c7292a11",
  "status_url": "/v1/data/jobs/3f7e2f6c-7a7d-4d16-9f5d-f9c4c7292a11",
  "credits_reserved": 12
}

Marketplace and Limits

Set Pages and Delivery

Bound product pages and set the marketplace delivery context.

curl -X POST "https://api.datablue.dev/v1/data/amazon/scrape" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "query": "wireless headphones",
  "modules": [
    "products"
  ],
  "num_results": 40,
  "page": 1,
  "page_limit": 4,
  "domain": "amazon.in",
  "country": "IN",
  "postal_code": "560034",
  "language": "en"
}'
Example response
{
  "success": true,
  "status": "queued",
  "platform": "amazon",
  "operation": "scrape",
  "modules": [
    "products"
  ],
  "job_id": "3f7e2f6c-7a7d-4d16-9f5d-f9c4c7292a11",
  "status_url": "/v1/data/jobs/3f7e2f6c-7a7d-4d16-9f5d-f9c4c7292a11",
  "credits_reserved": 12
}

Filters and Enrichment

Filter Listings

Apply supported sort, price, and Prime filters.

curl -X POST "https://api.datablue.dev/v1/data/amazon/scrape" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "query": "wireless headphones",
  "modules": [
    "products",
    "rankings"
  ],
  "sort_by": "rating",
  "min_price": 1000,
  "max_price": 5000,
  "prime_only": true
}'
Example response
{
  "success": true,
  "status": "queued",
  "platform": "amazon",
  "operation": "scrape",
  "modules": [
    "products"
  ],
  "job_id": "3f7e2f6c-7a7d-4d16-9f5d-f9c4c7292a11",
  "status_url": "/v1/data/jobs/3f7e2f6c-7a7d-4d16-9f5d-f9c4c7292a11",
  "credits_reserved": 12
}

Enrich Products

Request only the detail, offer, seller, variant, and review data you need.

curl -X POST "https://api.datablue.dev/v1/data/amazon/scrape" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "asin": "B0EXAMPLE1",
  "modules": [
    "products",
    "reviews"
  ],
  "detail_level": "full",
  "include_product_details": true,
  "include_offers": true,
  "max_offers": 5,
  "include_sellers": true,
  "include_variants": true,
  "include_reviews_preview": true,
  "reviews_limit": 8
}'
Example response
{
  "success": true,
  "status": "queued",
  "platform": "amazon",
  "operation": "scrape",
  "modules": [
    "products"
  ],
  "job_id": "3f7e2f6c-7a7d-4d16-9f5d-f9c4c7292a11",
  "status_url": "/v1/data/jobs/3f7e2f6c-7a7d-4d16-9f5d-f9c4c7292a11",
  "credits_reserved": 12
}

Queued Jobs

Check Job Status

Poll status_url when the start response is queued.

curl -X GET "https://api.datablue.dev/v1/data/jobs/JOB_ID" \
  -H "Authorization: Bearer YOUR_API_KEY"
Example response
{
  "success": true,
  "status": "completed",
  "job_id": "JOB_ID",
  "result": {
    "modules": [
      "products",
      "store"
    ],
    "data": {
      "products": [],
      "store": {}
    }
  }
}

Response

A completed request returns module data inline. A queued request returns job_id and status_url.

Error Handling

Handle 401 for authentication, 422 for invalid input, 429 for limits, and retry only transient failures.

Parameters

NameTypeRequirementDescription
querystringOptionalAmazon product search query. Required unless url, start_urls, or asin is supplied.
urlstringOptionalAmazon search, category, brand-store, or product URL.
start_urlsstring[]OptionalActor-compatible list of Amazon URLs to scrape.
categoryOrProductUrlsstring[] | object[]OptionalActor-compatible alias for start_urls. Objects with a url property are accepted.
asinstringOptionalDirect Amazon product ASIN.
modulesstring[]OptionalModules to return: products, store, a_plus, reviews, rankings, media.
num_results / maxItemsPerStartUrlnumberOptionalMaximum products to fetch (1-960).
pagenumberOptionalStarting Amazon listing page (1-20).
page_limit / maxSearchPagesPerStartUrlnumberOptionalMaximum Amazon listing pages to fetch (1-20).
domainstringOptionalAmazon domain, e.g. amazon.in, amazon.com, amazon.co.uk, amazon.de.
country / countryCodestringOptionalTwo-letter delivery or marketplace country code.
postal_code / zipCodestringOptionalDelivery postal or ZIP code.
sort_bystringOptionalSort order: relevance, popularity, price_low, price_high, rating, newest.
min_pricenumberOptionalMinimum price filter in whole currency units.
max_pricenumberOptionalMaximum price filter in whole currency units.
prime_onlybooleanOptionalFilter to Prime-eligible products when Amazon supports the filter.
languagestringOptionalLanguage code.
detail_level / scrapeProductDetailsstring | booleanOptionallisting for fast rows, full or scrapeProductDetails=true for product-detail enrichment.
include_product_detailsbooleanOptionalForce product detail enrichment for selected rows.
include_offers / maxOffersboolean | numberOptionalInclude offer listing data when available. maxOffers also enables offers.
max_offersnumberOptionalMaximum offers to include per product (0-20).
include_sellers / scrapeSellersbooleanOptionalInclude seller details when available.
include_variants / scrapeProductVariantPricesbooleanOptionalInclude variant ASINs/prices when available.
include_reviews_preview / includeReviewsPreviewbooleanOptionalInclude review snippets when available.
reviews_limitnumberOptionalRequested ceiling for public product-page review previews inside the reviews module (1-50).

Response fields

FieldTypeDescription
successbooleanWhether the inline request completed or the queued job was accepted.
statusstringcompleted, partial, failed, queued, running, or cancelled.
platform / operationstringStatic identifiers: amazon and scrape.
modulesstring[]Normalized module list used for the request.
data.productsarrayAmazon product rows with ASIN, title, URL, images, price, rating, review count, badges, delivery, seller, details, variants, offers, and reviews preview when available.
data.storeobjectBrand-store URL, total_skus, pages_fetched, skus, and product_refs when store is requested. Full products stay in data.products when that module is also requested.
data.a_plusobjectParsed A+ content, brand story, and product_ref when products is also requested; otherwise includes the enriched product.
data.reviewsobjectReview preview rows and product rating metadata when reviews is requested.
data.rankingsobjectRanked listing rows for search/category analysis when rankings is requested.
data.mediaobjectImages, gallery images, high-resolution images, videos_count, video_types, and product_ref when products is also requested.
job_idstringQueued job id when DataBlue returns HTTP 202.
status_urlstringPolling URL for queued full-scrape jobs.
credits_used / credits_reservednumberCredit count for completed inline runs or reserved credits for queued runs.
partialbooleanTrue when requested modules or enrichment are incomplete.
qualityobjectField and module coverage for completed product data.
warningsstring[]Non-fatal source, applicability, or enrichment warnings.
time_takennumberInline request time in seconds when completed immediately.
errorstringError message for failed requests.

Request and response

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": 8
}'
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",
  "credits_reserved": 12
}