apunkt/SurfSense
1
0
Fork 0
mirror of https://github.com/MODSetter/SurfSense.git synced 2026-07-20 23:21:06 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs(web): document amazon eu marketplace support

Browse source
This commit is contained in:
Anish Sarkar 2026-07-15 15:32:58 +05:30
parent 07fe0203e3
commit 92055846d1
1 changed files with 22 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

25
surfsense_web/content/docs/connectors/native/amazon.mdx
View file

@ -5,6 +5,8 @@ description: Scrape public Amazon product data as structured JSON
The Amazon scraper returns public product data as structured JSON: price and list price, rating and review breakdown, availability, marketplace offers, sellers, best-seller ranks, product variants, and on-page reviews. It only uses public, anonymous data — no login or seller account. Give it search terms or Amazon product, search, category, or best-seller URLs. The Amazon scraper returns public product data as structured JSON: price and list price, rating and review breakdown, availability, marketplace offers, sellers, best-seller ranks, product variants, and on-page reviews. It only uses public, anonymous data — no login or seller account. Give it search terms or Amazon product, search, category, or best-seller URLs.
Marketplace support is inferred from the Amazon URL or `domain` you provide. Supported public marketplaces include US (`amazon.com`), UK (`amazon.co.uk`), Germany (`amazon.de`), Italy (`amazon.it`), and Spain (`amazon.es`). France (`amazon.fr`) is supported in the scraper but remains best-effort because Amazon France is more sensitive to proxy-pool WAF challenges.
## Endpoint ## Endpoint
```bash ```bash
@ -15,10 +17,10 @@ POST /api/v1/workspaces/{workspace_id}/scrapers/amazon/scrape
| Field | Default | Description | | Field | Default | Description |
|-------|---------|-------------| |-------|---------|-------------|
| `urls` | — | Amazon product, search, category, best-seller, or short (`a.co` / `amzn.to`) URLs. Provide `urls` or `search_terms` | | `urls` | — | Amazon product, search, category, best-seller, or short (`a.co` / `amzn.to`) URLs. Marketplace is inferred from the URL, e.g. `amazon.co.uk`, `amazon.de`, `amazon.it`, or `amazon.es`. Provide `urls` or `search_terms` |
| `search_terms` | — | Search phrases run on the domain, e.g. `wireless earbuds`. Provide `search_terms` or `urls` | | `search_terms` | — | Search phrases run on the selected `domain`, e.g. `wireless earbuds`. Provide `search_terms` or `urls` |
| `max_items` | `10` | Max products per search term or category/best-seller URL (1–100) | | `max_items` | `10` | Max products per search term or category/best-seller URL (1–100) |
| `domain` | `www.amazon.com` | Amazon marketplace domain, e.g. `www.amazon.co.uk` | | `domain` | `www.amazon.com` | Amazon marketplace domain for `search_terms`, e.g. `www.amazon.co.uk`, `www.amazon.de`, `www.amazon.it`, or `www.amazon.es`. `www.amazon.fr` is best-effort due to Amazon WAF sensitivity |
| `include_details` | `true` | Fetch full product detail pages; `false` returns faster card-only results | | `include_details` | `true` | Fetch full product detail pages; `false` returns faster card-only results |
| `max_offers` | `0` | Extra marketplace offers per product (0–100); `0` = featured offer only | | `max_offers` | `0` | Extra marketplace offers per product (0–100); `0` = featured offer only |
| `include_sellers` | `false` | Enrich the product and each offer with the seller's public profile | | `include_sellers` | `false` | Enrich the product and each offer with the seller's public profile |
@ -43,6 +45,23 @@ curl -X POST "$BASE_URL/api/v1/workspaces/1/scrapers/amazon/scrape" \
}' }'
``` ```
## Marketplace examples
```json
{
"urls": [
"https://www.amazon.co.uk/s?k=usb+c+cable",
"https://www.amazon.de/s?k=mechanische+tastatur",
"https://www.amazon.it/s?k=cavo+usb+c",
"https://www.amazon.es/s?k=cable+usb+c"
],
"max_items": 5,
"include_details": false
}
```
For `search_terms`, set `domain` to the marketplace you want to search. For direct URLs, the scraper infers the marketplace from each URL.
The response is `{ "items": [...] }` — one item per product, plus structured error items for any input that could not be resolved. Billing is per returned product; error items are never billed. The response is `{ "items": [...] }` — one item per product, plus structured error items for any input that could not be resolved. Billing is per returned product; error items are never billed.
For the full input and output JSON schemas and generated code snippets in your language, open **API Playground → Amazon → Scrape** in your workspace. For the full input and output JSON schemas and generated code snippets in your language, open **API Playground → Amazon → Scrape** in your workspace.