# AliExpress on Onekey

> 9 endpoints for AliExpress (0 stable, 9 beta), 2 to 3 credits each. Category: E-commerce & marketplaces. One key, one JSON shape.

Base URL: https://api.onekey.dev
Auth: header `x-api-key: <key>`. Call shape: `GET /v1/{platform}/{endpoint}?{params}`.
Every response is `{success, data, metadata, error}`; check `success` first. Cost is in `metadata.credits_charged`. Free when served from cache (0.2 credit for a cached response over 100 KB). Failed and not-found calls are refunded.
Status: stable = verified against the live source; beta = not yet verified, fields may be missing.
Access: 9 of 9 endpoints are marked "needs a pack" or "may need a pack": free-grant credits reach only the open fetch path; a verified email and a purchased pack unlock the rest.

Page: https://onekey.dev/platforms/aliexpress
Reference (Markdown): https://onekey.dev/docs/api/aliexpress.md
All docs: https://onekey.dev/llms.txt

## Canonical fields returned

Unified-schema fields (same names on every platform), with how many of the 9 mapped AliExpress endpoints return each:

- `entity.name` (string): 8
- `entity.url` (URL): 7
- `entity.description` (string): 5
- `entity.id` (string): 5
- `media.thumbnailUrl` (URL): 5
- `entity.stats.rating` (number): 4
- `entity.stats.ratingCount` (integer): 4
- `listing.currency` (string): 4
- `listing.price` (number): 4
- `listing.brand` (string): 3
- `author.displayName` (string): 1
- `content.createdAt` (ISO 8601 date): 1
- `content.id` (string): 1
- `content.text` (string): 1
- `content.title` (string): 1
- `engagement.votes` (integer): 1
- `entity.slug` (string): 1
- plus 3 platform-specific fields under `ext.`

## Endpoints

### aliexpress.categories

AliExpress categories.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/aliexpress/categories` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `entity.slug`
- Reference: https://onekey.dev/docs/api/aliexpress/categories.md

### aliexpress.product

AliExpress product page metadata by item id.
- Price: 3 credits per fresh call. Status: beta. Access: needs a pack. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/aliexpress/product?item_id=1005005123456789` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `item_id` (string, required): AliExpress item id
- Fields returned: `entity.url`, `entity.name`, `entity.description`, `media.thumbnailUrl`, `ext.canonicalUrl`
- Reference: https://onekey.dev/docs/api/aliexpress/product.md

### aliexpress.product_shipping

AliExpress shipping options for a product SKU.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/aliexpress/product_shipping?product_id=123456789&sku_id=12000012345678901` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `product_id` (string, required): Product id as it appears on the product page URL
  - `sku_id` (string, required): SKU id of a colour or size variant (comes back on every product)
- Fields returned: `entity.name`, `listing.price`, `listing.currency`, `ext.deliveryDays`
- Reference: https://onekey.dev/docs/api/aliexpress/product_shipping.md

### aliexpress.product_similar

Products similar to an AliExpress product.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/aliexpress/product_similar?product_id=123456789` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `product_id` (string, optional): Product id as it appears on the product page URL
  - `url` (string, optional): Full URL of the product page (alternative to the id)
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `entity.description`, `media.thumbnailUrl`, `listing.price`, `listing.currency`, `listing.brand`, `entity.stats.rating`, `entity.stats.ratingCount`
- Reference: https://onekey.dev/docs/api/aliexpress/product_similar.md

### aliexpress.promo

AliExpress featured promotions.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/aliexpress/promo` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `entity.description`, `entity.stats.rating`, `entity.stats.ratingCount`, `media.thumbnailUrl`
- Reference: https://onekey.dev/docs/api/aliexpress/promo.md

### aliexpress.reviews

AliExpress product reviews.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/aliexpress/reviews?product_id=123456789` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `product_id` (string, optional): Product id as it appears on the product page URL
  - `url` (string, optional): Full URL of the product page (alternative to the id)
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `content.id`, `content.title`, `content.text`, `content.createdAt`, `author.displayName`, `engagement.votes`, `ext.rating`
- Reference: https://onekey.dev/docs/api/aliexpress/reviews.md

### aliexpress.search

AliExpress search results page (links only).
- Price: 3 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/aliexpress/search?q=phone%20case` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): Search query
- Fields returned: `entity.url`, `entity.name`
- Reference: https://onekey.dev/docs/api/aliexpress/search.md

### aliexpress.search_hot

Hot AliExpress products.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/aliexpress/search_hot` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `entity.description`, `media.thumbnailUrl`, `listing.price`, `listing.currency`, `listing.brand`, `entity.stats.rating`, `entity.stats.ratingCount`
- Reference: https://onekey.dev/docs/api/aliexpress/search_hot.md

### aliexpress.search_promo

AliExpress products in a featured promotion.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/aliexpress/search_promo?promotion_name=New%20Arrival` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `promotion_name` (string, required): Promotion name exactly as returned by the promotions endpoint
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `entity.description`, `media.thumbnailUrl`, `listing.price`, `listing.currency`, `listing.brand`, `entity.stats.rating`, `entity.stats.ratingCount`
- Reference: https://onekey.dev/docs/api/aliexpress/search_promo.md

## Sample request

```bash
curl "https://api.onekey.dev/v1/aliexpress/product?item_id=1005005123456789" \
  -H "x-api-key: YOUR_API_KEY"
```