# AliExpress API by APISH (`apish/aliexpress-api`) Actor

Search AliExpress and pull items with prices, SKUs, specs and store details, plus reviews with photos, as JSON for any ship-to country, via APISH. Pay per credit; failed calls are free.

- **URL**: https://apify.com/apish/aliexpress-api.md
- **Developed by:** [APISH](https://apify.com/apish) (community)
- **Categories:** E-commerce
- **Features:** Limited permissions
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

$4.00 / 1,000 credits

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## AliExpress API by APISH

Get public AliExpress data as clean, consistent JSON: one AliExpress item, aliExpress item reviews, aliExpress search. 3 endpoints, one response shape, numbers parsed, absolute URLs.

### How to use

1. Pick an **Endpoint**. Each option shows what it returns and its price in credits.
2. Enter its **Parameters** as JSON, for example `{"q":"phone case"}`. All parameters are listed below.
3. Run. Each call becomes one row in the dataset. Use **Batch** to run the same endpoint for many inputs and **Pages per input** to follow pagination.

### Pricing

Pay per event: you pay per APISH credit the call used. The price of each endpoint is in the table below. Calls that fail on our side (server errors, timeouts, blocks) are free.

### Endpoints

| Endpoint | Returns | Required parameters | Credits |
|---|---|---|---|
| `/aliexpress/v1/product` | One AliExpress item | `url` | 1 |
| `/aliexpress/v1/reviews` | AliExpress item reviews | `url` | 1 |
| `/aliexpress/v1/search` | AliExpress search | `q` | 1 |

### Output

Each dataset row has `endpoint`, `params`, `status`, `credits_used` and the endpoint's data. Add `"raw": 1` to the parameters to also get the site's original record, or `"fields": "a,b.c"` to return only the fields you need.

### Endpoint details

#### One AliExpress item

Endpoint `/aliexpress/v1/product` · 1 credit per successful call.

AliExpress sometimes answers with a verification check instead of the item; the call tries again by itself (up to 3 times) before answering.

Parameters:

- `url` (required)
- `ship_to` — one of `US`, `GB`, `DE`, `FR`, `ES`, `IT`, `BR`, `RU`, `NL`, `PL`, `TR`, `KR`, `JP`, `IL`, `TH`, `VN`, `ID`: Destination country (default US): prices, shipping options and delivery times for it. AliExpress words the product in that market's language (DE in German, JP in Japanese...).
- `currency`: Currency of the prices, e.g. EUR, GBP, JPY (default USD).
- `lang`: Language (es, fr, de, it, pt, ru, nl, pl, tr, ko, ja, ar, he, th, vi, id): the product in that language, priced and shipped for its market. Leave out with ship_to.

Example parameters: `{"url":"https://www.aliexpress.com/item/1005013156466549.html"}`

#### AliExpress item reviews

Endpoint `/aliexpress/v1/reviews` · 1 credit per successful call.

Pass `next_page` back as `page`. `next_page` is null when the page is short. `filter` (or `with_photos=true`) narrows to reviews with photos, from the reviewer's own country (`local`) or with a follow-up review; `country` and `language` pick the review set and translation the site shows a shopper there. The response echoes `filter`, `country` and `language`.

Parameters:

- `url` (required): Item URL or product id.
- `page`: Page number. Pass `next_page` from the previous response; `next_page` is null on the last page.
- `filter` — one of `all`, `with_photos`, `local`, `additional`: all (default), with_photos, local (reviews from the shopper's country), additional (with a follow-up review).
- `with_photos`: true: same as filter=with_photos.
- `country`: Shopper country code (default US).
- `language`: Review language / translation (default en): en, es, fr, de, it, pt, ru, nl, pl, tr, ko, ja, ar, he, th, vi, id.

Example parameters: `{"url":"1005005244562338"}`

#### AliExpress search

Endpoint `/aliexpress/v1/search` · 1 credit per successful call.

Pass `next_page` back as `page`. `next_page` is null when the page is short. `ship_to`, `currency` and `lang` show prices, shipping and titles as a shopper in that country with that currency and language sees them; `category_id` keeps results to one category.

Parameters:

- `q` (required)
- `page`: Page number. Pass `next_page` from the previous response; `next_page` is null on the last page.
- `sort` — one of `default`, `price_asc`, `price_desc`, `orders`: orders: best-selling first.
- `min_price`: Lowest price, in the response currency (USD by default).
- `max_price`: Highest price, in the response currency (USD by default).
- `ship_from`: Only items shipping from this country (US, CN, ES, FR, DE…).
- `free_shipping`: Ask AliExpress for free-shipping items (applied by AliExpress, best effort).
- `category_id`: Only this AliExpress category (its numeric id, as in category links).
- `ship_to`: Destination country code (default US): prices and delivery for shoppers there.
- `currency`: Currency code for prices (default USD), e.g. EUR, GBP.
- `lang`: Language of titles (default en): en, es, fr, de, it, pt, ru, nl, pl, tr, ko, ja, ar, he, th, vi, id.

Example parameters: `{"q":"phone case"}`

### Support

Questions, bugs or a missing field? Open an issue in this Actor's Issues tab and we will reply there.

Public data only: nothing behind a login. You are responsible for how you use the data you collect.

# Actor input Schema

## `endpoint` (type: `string`):

Which AliExpress endpoint to call. Each option shows what it returns and its price in credits.

## `params` (type: `object`):

Query parameters for the endpoint, as JSON. See the README for every endpoint's parameters. Example: {"q":"phone case"}

## `batch` (type: `array`):

Run the same endpoint for many inputs: a list of parameter objects. Each item is one call. Leave empty to use Parameters.

## `maxPages` (type: `integer`):

For paginated endpoints: follow next_cursor up to this many pages per input. 1 = first page only.

## Actor input object example

```json
{
  "endpoint": "/aliexpress/v1/search",
  "params": {
    "q": "phone case"
  },
  "batch": [],
  "maxPages": 1
}
```

# Actor output Schema

## `results` (type: `string`):

One row per call: endpoint, params, status, credits_used and the data.

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "endpoint": "/aliexpress/v1/search",
    "params": {
        "q": "phone case"
    },
    "batch": []
};

// Run the Actor and wait for it to finish
const run = await client.actor("apish/aliexpress-api").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "endpoint": "/aliexpress/v1/search",
    "params": { "q": "phone case" },
    "batch": [],
}

# Run the Actor and wait for it to finish
run = client.actor("apish/aliexpress-api").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "endpoint": "/aliexpress/v1/search",
  "params": {
    "q": "phone case"
  },
  "batch": []
}' |
apify call apish/aliexpress-api --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,apish/aliexpress-api"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/HnJyJUDGLHdK3Mclm/builds/atxMpwTEaX7ncKN2P/openapi.json
