> Documentation index: https://docs.scrapier.io/llms.txt
> Auth: header `X-API-Key: <key>` · Base: https://api.scrapier.io/api/v2 · Synchronous; paginate with `cursor` ← `data.next_cursor`.

# AliExpress Products

Structured AliExpress data: send `queries`. Cursor-paginated, 1 credit per successful call.

`GET|POST https://api.scrapier.io/api/v2/aliexpress-products/` · 1 credit per successful call · Cursor-paginated

## Overview

Call `GET /api/v2/aliexpress-products/` with `queries`. The results are in `data.products`; send `data.next_cursor` back as `cursor` to get the next page. 6 optional parameters refine the call (see Parameters).

## Request

```bash
curl -G "https://api.scrapier.io/api/v2/aliexpress-products/" \
  -H "X-API-Key: YOUR_API_KEY" \
  --data-urlencode "queries=wireless earbuds" \
  --max-time 210
```

```python
import requests

resp = requests.get(
    "https://api.scrapier.io/api/v2/aliexpress-products/",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={"queries": "wireless earbuds"},
    timeout=210,
)
body = resp.json()
if not resp.ok:
    raise RuntimeError(body.get("error") or body.get("detail"))

print(body["data"]["products"])
```

POST with a JSON body works too (same parameters; the body is merged over the query string).

## Parameters

| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| `X-API-Key` (header) | string | yes | — | Your API key. |
| `queries` | string | yes | e.g. `wireless earbuds` | AliExpress search keyword OR ready search/category/item URL (auto-detected). Required first call. Aliases: searchQueries, q. |
| `cursor` | string | no | — | Pagination cursor returned in the previous response's `next_cursor`. Pass it back unchanged to fetch the next page. When `next_cursor` is null, you have reached the last page. |
| `sort_by` | string | no | `default` | default \| price_asc \| price_desc \| orders. One of: `default`, `price_asc`, `price_desc`, `orders`. Locked in cursor. |
| `currency` | string | no | `USD` | Currency (pinned via cookie). Locked in cursor. |
| `region` | string | no | `US` | Region code. Locked in cursor. |
| `locale` | string | no | `en_US` | Locale. Locked in cursor. |
| `fetch_reviews` | boolean | no | `false` | Enrich reviewCount/rating per product (one extra request each; heavy, default off; time-boxed; rows not finished in time carry reviewsEnriched=false). Locked in cursor. |
| `use_proxy` | boolean | no | `true` | Route the request through Scrapier's residential proxy pool. Default: `true`. Leave as is unless support tells you otherwise. |
| `raw_data` | boolean | no | `false` | When true, the response carries the full raw upstream payload(s) the scraper received (GraphQL / JSON API bodies, HTML, embedded JSON-LD -- exactly as the platform returned them) under `raw_responses`, in place of the formatted items. When false (default) you get the formatted output. Pagination (`cursor` / `next_cursor`) works the same in both modes. |

## Response

HTTP 200. Results are in `data.products`. Sample from the live catalog, arrays trimmed to 3 items.

```json
{
  "success": true,
  "data": {
    "url": "https://www.aliexpress.com/w/wholesale-wireless-earbuds.html",
    "page": 1,
    "page_size": 60,
    "products": [
      {
        "productId": "1005006789012345",
        "title": "Wireless Earbuds Bluetooth 5.3 Noise Cancelling TWS Headphones",
        "productUrl": "https://www.aliexpress.us/item/1005006789012345.html",
        "searchQuery": "wireless earbuds",
        "priceCurrent": "US $12.99",
        "priceCurrency": "$",
        "ratingValue": 4.8,
        "reviewCount": 1240,
        "soldCount": 5000,
        "soldDescription": "5,000+ sold",
        "tags": "Bulk deal",
        "scrapedAt": "2026-06-18T12:00:00.000Z",
        "reviewsEnriched": true,
        "position": 1
      }
    ],
    "next_cursor": "zc1.eNpjYGBg...",
    "timing": {
      "total_s": 11.8,
      "search_pages_s": [
        4.1
      ],
      "enrich_s": 7.2
    },
    "enrichment": {
      "requested": 60,
      "enriched": 60
    }
  }
}
```

## Response fields

| Field | Type | Example | Description |
|---|---|---|---|
| `url` | string | `https://www.aliexpress.com/w/wholesale-wirele…` |  |
| `page` | integer | `1` |  |
| `page_size` | integer | `60` |  |
| `products` | array | `[1 item]` | The results. |
| `next_cursor` | string | `zc1.eNpjYGBg...` | Pass back as `cursor` for the next page. `null` on the last page. |
| `timing` | object | `{…}` |  |
| `enrichment` | object | `{…}` |  |
| `products[].productId` | string | `1005006789012345` |  |
| `products[].title` | string | `Wireless Earbuds Bluetooth 5.3 Noise Cancelli…` |  |
| `products[].productUrl` | string | `https://www.aliexpress.us/item/10050067890123…` |  |
| `products[].searchQuery` | string | `wireless earbuds` |  |
| `products[].priceCurrent` | string | `US $12.99` |  |
| `products[].priceCurrency` | string | `$` |  |
| `products[].ratingValue` | number | `4.8` |  |
| `products[].reviewCount` | integer | `1240` |  |
| `products[].soldCount` | integer | `5000` |  |
| `products[].soldDescription` | string | `5,000+ sold` |  |
| `products[].tags` | string | `Bulk deal` |  |
| `products[].scrapedAt` | string | `2026-06-18T12:00:00.000Z` |  |
| `products[].reviewsEnriched` | boolean | `true` |  |
| `products[].position` | integer | `1` |  |

## Pagination

Pass `data.next_cursor` back as `cursor` until it is `null`. Required inputs are ignored once a cursor is sent. Each page is one billed call.

```python
import requests

URL = "https://api.scrapier.io/api/v2/aliexpress-products/"
HEADERS = {"X-API-Key": "YOUR_API_KEY"}
params = {"queries": "wireless earbuds"}
items = []

for _ in range(10):  # each page is one billed call
    resp = requests.get(URL, headers=HEADERS, params=params, timeout=210)
    resp.raise_for_status()
    data = resp.json()["data"]
    items.extend(data.get("products") or [])
    if not data.get("next_cursor"):  # None = last page
        break
    params = {"cursor": data["next_cursor"]}
```

## Errors

Failed calls are free. Branch on HTTP status; the message is in `error` (or `detail`). See https://docs.scrapier.io/errors.md

- **400** Bad input. The exact message varies by endpoint. `{"success":false,"error":"…"}`
- **402** Balance below the endpoint's price. `{"error":"Insufficient credits. Buy more to scrape more.","balance":1,"required":2}`
- **403** Invalid or unknown API key. `{"detail":"Authentication service unavailable or invalid API key."}`
- **429** Throttled — wait for Retry-After. `{"detail":"Request was throttled. Expected available in N seconds."}`
- **404** unknown slug · **503** busy (retry after `Retry-After`) · **5xx** upstream failure or timeout (retry with backoff).

## Notes

- Locked into the cursor: `sort_by`, `currency`, `region`, `locale`, `fetch_reviews`. Set them on the first call; later pages reuse them.

## Related

- [AliExpress Reviews](https://docs.scrapier.io/api-reference/aliexpress/aliexpress-reviews.md): Structured AliExpress data: send `product_id`. Cursor-paginated, 1 credit per successful call.
