# SocialCrawl API: amazon endpoints
# Base URL: https://www.socialcrawl.dev
# Auth: x-api-key header
# Full docs: https://www.socialcrawl.dev/docs/amazon

## GET /v1/amazon/shop
Get Amazon shop page
Credit cost: 1 (standard)
Parameters:
- url (required): Full URL of the Amazon shop or storefront page
curl -G "https://www.socialcrawl.dev/v1/amazon/shop" \
  --data-urlencode "url=https://www.amazon.com/shop/alix_earle" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/amazon/product-search
Search Amazon products by keyword
Credit cost: 1 (standard)
Parameters:
- query (required): Search keyword or phrase.
- country (optional, enum: US | GB | CA | DE | FR | IT | ES | JP | IN | MX | BR | AU | NL): Amazon marketplace as an ISO 3166-1 alpha-2 country code (default US). Supported: US, GB, CA, DE, FR, IT, ES, JP, IN, MX, BR, AU, NL. Non-US marketplaces are best-effort; an occasional timeout is refunded.
- depth (optional, integer): Maximum number of products to return in ONE call (default 20, max 700). Use it when you would rather make a single large request than paginate: it selects a different, slower search backend whose latency grows with depth, and a timeout is auto-refunded. Leave it unset for the fast default page size, which is the better choice for keyword→ASIN resolution. A depth of 1 to 3 falls back to the fast default page when the slower backend times out, so that answer has at most `depth` rows and carries `data.details.depth_truncated: true`. When the slower backend answers it may return more rows than `depth` (it returns its whole first page), as before.
- page (optional, integer): Page number, starting at 1. Prefer the universal cursor parameter.
- max_pages (optional, integer): 1 to 50 (default 1, or 50 when `max_items` or `max_credits` is sent). Walk up to this many pages in one call and return the rows from all of them. Each page walked is billed exactly as one call to this endpoint (a cached page is free) and counts against your rate limit; its charge and any refund are recorded under the page's own request id, listed in `data.walk.request_ids`. The walk stops early at the last page, or when the request's time budget runs low; `data.walk.stopped` says why (`end`, `max_pages`, `max_items`, `max_credits`, `time_budget`, `page_error`) and `pagination.next_cursor` continues from where it stopped.
- max_items (optional, integer): 1 to 5000. Get more in one call: keep walking pages until the response holds at least this many rows, then stop with `data.walk.stopped: "max_items"`. The last page is returned whole (it was billed), so `data.items` can hold up to one page more than this, and `pagination.next_cursor` resumes right after it without skipping a row. Walks up to 50 pages unless `max_pages` says fewer; each page is billed as one call (a cached page is free). Add `max_credits` to cap the spend. A long walk can stop on the time budget first (`"time_budget"`): send the returned cursor with the same params to continue.
- max_credits (optional, integer): 1 to 100000. The most this call may spend, across every page it walks. A page starts only while the credits already spent plus that page's price (or, when higher, the most any page of this walk has cost) still fit, so the call never goes past it; the walk then stops with `data.walk.stopped: "max_credits"` and the cursor to resume. Sent alone, it walks as far as the budget goes (up to 50 pages). A value below the price of one page is a free 400 whose `error.details.page_credits` names that price. Credits a row join (`include=`) adds are known only once a page has run, so page 1 is checked against its own price.
Worth sending:
- country=US: Results for one country.
curl -G "https://www.socialcrawl.dev/v1/amazon/product-search" \
  --data-urlencode "query=wireless earbuds" \
  --data-urlencode "country=US" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/amazon/product
Get an Amazon product by ASIN
Credit cost: 5 (advanced)
Parameters:
- asin (required): 10-character Amazon ASIN (the product identifier).
- country (optional, enum: US | GB | CA | DE | FR | IT | ES | JP | IN | MX | BR | AU | NL): Amazon marketplace as an ISO 3166-1 alpha-2 country code (default US). Supported: US, GB, CA, DE, FR, IT, ES, JP, IN, MX, BR, AU, NL. The same ASIN can be a different listing, price or stock state on each marketplace, so pass the one the ASIN came from.
Worth sending:
- country=US: Results for one country.
curl -G "https://www.socialcrawl.dev/v1/amazon/product" \
  --data-urlencode "asin=B0FQFB8FMG" \
  --data-urlencode "country=US" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/amazon/reviews
Get Amazon product reviews
Credit cost: 5-9 (metered): 5 credits per page. The default labels (sentiment, issue) are free. label=reports, incentivized or injection holds 4 extra credits and refunds down to 1 credit per started 25 reviews that were newly judged (the first 100 reviews of a page are judged): reviews already labelled are free, a page where nothing could be judged refunds the whole extra, and a cached page is free.
Parameters:
- asin (required): 10-character Amazon ASIN (the product identifier).
- country (optional, enum: US | GB | CA | DE | FR | IT | ES | JP | IN | MX | BR | AU | NL): Amazon marketplace as an ISO 3166-1 alpha-2 country code (default US). Supported: US, GB, CA, DE, FR, IT, ES, JP, IN, MX, BR, AU, NL. Amazon shows reviews across a product's whole variant family, so a review row can originate from a sibling ASIN; review.entity_id is always the ASIN you requested.
- label (optional, string): Optional CSV of SocialCrawl labels to add to every review. Without this param every page already carries sentiment and issue, free; label= adds the labels you name to them (the defaults keep running). sentiment and issue are free when asked for too; reports, incentivized and injection add 1 credit per started 25 newly judged reviews. judgments=off (or label=none) turns the default labels off. They read the review's title and text, never its stars. sentiment: how the reviewer feels, on five levels (level 0 to 4, score_0_1, confidence), plus rating_mismatch, true when the words clearly contradict the star rating (a glowing text under 1 star, a furious one under 5), null when the review has no rating. issue: the main problem the review reports (label: product_defect, sizing_or_fit, shipping_or_delivery, customer_service, price_or_value, missing_feature, other, or none, with confidence; label is null when unsure). reports (needs reports=): does this review say that the thing you describe happened (p, 0 to 1). incentivized: does the reviewer say they got the product free, discounted or rewarded for the review (p), and did the text carry a disclosure such as 'in exchange for my honest review', Vine or 체험단 (disclosed). injection flags text that addresses an AI system and tries to direct it (flagged, p); it never drops or rewrites a row. These are signals to read, never a verdict on a review or a reviewer. A review that could not be judged carries labels: null. Reviews already labelled for anyone are free, and so is a cached page. data.labels reports what was judged and billed.
- reports (optional, string): Required by label=reports, ignored otherwise. What to look for, in plain words, up to 300 characters, for example reports=the battery drains quickly or reports=배송이 늦음. Every review gains labels.reports.p, the probability that it says so, in any wording or language. Without it label=reports is skipped with the warning label_reports_needs_reports and is not billed.
- judgments (optional, enum: on | off): Optional, on (the default) or off. By default every row gains free SocialCrawl judgments (computed.labels, and computed.relevance on search endpoints), reported in data.labels (mode default) and data.relevance (origin default), each with a status (complete, partial or skipped) and pending: the rows still being judged when the page was sent, which carry null now and are filled on your next call or cached read. Default judgments never add credits, never change an existing field, and never drop or reorder a row. off returns the page exactly as before, with none of those keys. label=none does the same.
- dry_run (optional, enum: 1): Optional. When 1, return a cost preview for this labelled or relevance-filtered request without fetching the page or judging any row. data.estimate reports rows_expected, rows_cached, label_credits_min, label_credits_max and base_credits. 0 credits charged.
- label_evidence (optional, enum: 1): Optional, only with label=. When 1, every labelled row also carries computed.labels_evidence.<preset> = { quote, sentence_index }: the sentence in the row that most clearly shows the label, copied verbatim. Absent or null when no single sentence shows it.
- fit (optional, enum: goal): Optional. When goal, keep the rows and fields needed for the goal you pass in goal= (plus any that are uncertain, and the first and last), and replace the rest with a stub. data.held_back lists the held ids and a recall id that re-reads the full page from cache at no extra charge. Without this param the page is unchanged.
- goal (optional, string): Required by fit=goal. What you are trying to do, in your own words, up to 300 characters.
- fit_tokens (optional, integer): Optional, only with fit=goal. Soft cap on how much of the page to keep, in tokens. Uncertain blocks and the first and last block are kept even if they exceed it.
- since (optional, string): Only rows published on or after this date: YYYY-MM-DD (midnight UTC) or an ISO 8601 timestamp. Rows older than it are left off each page. This list is not in date order, so the walk does not stop at the date: keep following `next_cursor`, and each page costs what a page costs even when every row on it is filtered out. A row with no date is kept. `published_after`, `start_date`, `from_date`, `publish_time` (`yesterday`, `this-week`, `this-month`, `last-3-months`, `last-6-months`) and `max_age_days` are accepted and applied as `since`.
- until (optional, string): Only rows published on or before this date: YYYY-MM-DD (that whole UTC day is included) or an ISO 8601 timestamp. Newer rows are left off each page and the walk does not stop, so older pages follow. A row with no date is kept. `published_before`, `end_date` and `to_date` are accepted and applied as `until`.
Worth sending:
- label=issue: Names the product issue each review raises, at no extra credits; sentiment is free too.
- country=US: Results for one country.
curl -G "https://www.socialcrawl.dev/v1/amazon/reviews" \
  --data-urlencode "asin=B0BTYCRJSS" \
  --data-urlencode "label=issue" \
  --data-urlencode "country=US" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/amazon/sellers
Get Amazon sellers and offers for a product
Credit cost: 1 (standard)
Parameters:
- asin (required): 10-character Amazon ASIN (the product identifier).
- country (optional, enum: US | GB | CA | DE | FR | IT | ES | JP | IN | MX | BR | AU | NL): Amazon marketplace as an ISO 3166-1 alpha-2 country code (default US). Supported: US, GB, CA, DE, FR, IT, ES, JP, IN, MX, BR, AU, NL. Note: non-US marketplaces (especially EU) are best-effort: the upstream provider is slower and occasionally times out for these; such calls are refunded, and US is the most reliable marketplace.
Worth sending:
- country=US: Results for one country.
curl -G "https://www.socialcrawl.dev/v1/amazon/sellers" \
  --data-urlencode "asin=B09SM24S8C" \
  --data-urlencode "country=US" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/amazon/best-sellers
Get Amazon Best Sellers in a category
Credit cost: 1 (standard)
Parameters:
- category (required): Best Sellers category path from the Amazon Best Sellers URL: a department slug such as software or officeproduct, or a department plus node id for a subcategory, such as officeproduct/202900031 (Karten on amazon.de).
- country (optional, enum: US | GB | CA | DE | FR | IT | ES | JP | IN | MX | BR | AU | NL): Amazon marketplace as an ISO 3166-1 alpha-2 country code (default US).
- type (optional, enum: BEST_SELLERS | NEW_RELEASES | MOVERS_AND_SHAKERS | MOST_WISHED_FOR | GIFT_IDEAS): List type: BEST_SELLERS (default), NEW_RELEASES, MOST_WISHED_FOR, GIFT_IDEAS, or MOVERS_AND_SHAKERS. MOVERS_AND_SHAKERS currently returns an empty list at 0 credits on US, GB and DE, because Amazon itself shows no Movers and Shakers rows. A category with no list of the requested type also returns empty and free.
- page (optional, integer): Page number, starting at 1. Prefer the universal cursor parameter.
- max_pages (optional, integer): 1 to 50 (default 1, or 50 when `max_items` or `max_credits` is sent). Walk up to this many pages in one call and return the rows from all of them. Each page walked is billed exactly as one call to this endpoint (a cached page is free) and counts against your rate limit; its charge and any refund are recorded under the page's own request id, listed in `data.walk.request_ids`. The walk stops early at the last page, or when the request's time budget runs low; `data.walk.stopped` says why (`end`, `max_pages`, `max_items`, `max_credits`, `time_budget`, `page_error`) and `pagination.next_cursor` continues from where it stopped.
- max_items (optional, integer): 1 to 5000. Get more in one call: keep walking pages until the response holds at least this many rows, then stop with `data.walk.stopped: "max_items"`. The last page is returned whole (it was billed), so `data.items` can hold up to one page more than this, and `pagination.next_cursor` resumes right after it without skipping a row. Walks up to 50 pages unless `max_pages` says fewer; each page is billed as one call (a cached page is free). Add `max_credits` to cap the spend. A long walk can stop on the time budget first (`"time_budget"`): send the returned cursor with the same params to continue.
- max_credits (optional, integer): 1 to 100000. The most this call may spend, across every page it walks. A page starts only while the credits already spent plus that page's price (or, when higher, the most any page of this walk has cost) still fit, so the call never goes past it; the walk then stops with `data.walk.stopped: "max_credits"` and the cursor to resume. Sent alone, it walks as far as the budget goes (up to 50 pages). A value below the price of one page is a free 400 whose `error.details.page_credits` names that price. Credits a row join (`include=`) adds are known only once a page has run, so page 1 is checked against its own price.
Worth sending:
- country=US: Results for one country.
curl -G "https://www.socialcrawl.dev/v1/amazon/best-sellers" \
  --data-urlencode "category=software" \
  --data-urlencode "country=US" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/amazon/deals
Get current Amazon deals
Credit cost: 1 (standard)
Parameters:
- country (optional, enum: US | GB | CA | DE | FR | IT | ES | JP | IN | MX | BR | AU | NL): Amazon marketplace as an ISO 3166-1 alpha-2 country code (default US).
Worth sending:
- country=US: Results for one country.
curl -G "https://www.socialcrawl.dev/v1/amazon/deals" \
  --data-urlencode "country=US" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/amazon/seller
Get an Amazon seller profile
Credit cost: 1 (standard)
Parameters:
- seller_id (required): Amazon seller id, the seller= value on a seller profile URL.
- country (optional, enum: US | GB | CA | DE | FR | IT | ES | JP | IN | MX | BR | AU | NL): Amazon marketplace as an ISO 3166-1 alpha-2 country code (default US).
Worth sending:
- country=US: Results for one country.
curl -G "https://www.socialcrawl.dev/v1/amazon/seller" \
  --data-urlencode "seller_id=A294P4X9EWVXLJ" \
  --data-urlencode "country=US" \
  -H "x-api-key: YOUR_API_KEY"