Skip to content
Scrappa Get API key
AliExpress API 1 credit/request

AliExpress Search API Documentation

GET https://scrappa.co/api/aliexpress/search

AliExpress Search API Documentation Search AliExpress products by keyword: for each result the product id, title, web url, image and gallery, price, original price, discount percent, rating, sold count and text, selling points, promotion and a sponsored flag. Narrow results with a sort order, a price range, a ship-from country and filters. The facets list in the response holds every filter you can use, with the exact value to pass in the filters parameter. sort_options lists the sort values. No category tree exists, so use the facets to narrow a search. Prices are numbers in the currency of the result. Currency and language follow the market of the request, so they can differ between calls. Failed requests are never charged. A valid search without hits is a successful response with an empty results list.

AliExpress Search API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/aliexpress/search
Auth header
x-api-key
Cost
1 credit/request
query = coffee shops
Response preview
200 OK
{
    "data": {
        "page": 1,
        "sort": "default",
        "query": "phone case",
        "facets": [
            {
                "type": "switch",
                "multi": true,
                "title": "Deals & discounts",
                "options": [
                    {
                        "label": "Free shipping",
                        "value": "filterCode:freeshipping",
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

1 required parameter needed before sending a request.

6 optional filters available.

query string Required

Search keywords, e.g. phone case.

Example value coffee shops
page integer Optional

Page number from 1 to 60. Defaults to 1.

Example value 1
sort string Optional

Sort order: default, orders, price_asc or price_desc. Defaults to default.

Example value relevance
min_price number Optional

Lowest price, e.g. 5. Uses the currency of the results.

Example value 10
max_price number Optional

Highest price, e.g. 20. Must not be lower than min_price.

Example value 10
ship_from string Optional

Two-letter country code of the warehouse, e.g. US.

Example value example
filters string Optional

Comma separated filter values taken from the facets of a previous response, e.g. filterCode:freeshipping or 11745-4352280.

Example value example

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

data meta success
JSON Response
200 OK
{
    "data": {
        "page": 1,
        "sort": "default",
        "query": "phone case",
        "facets": [
            {
                "type": "switch",
                "multi": true,
                "title": "Deals & discounts",
                "options": [
                    {
                        "label": "Free shipping",
                        "value": "filterCode:freeshipping",
                        "selected": false
                    }
                ]
            },
            {
                "type": "switch",
                "multi": true,
                "title": "Delivery & service",
                "options": [
                    {
                        "label": "Choice",
                        "value": "filterCode:choice_atm",
                        "selected": false
                    }
                ]
            }
        ],
        "results": [
            {
                "url": "https://www.aliexpress.com/item/1005012594256426.html",
                "price": {
                    "amount": 53.86,
                    "currency": "UAH",
                    "formatted": "53,86 \u0433\u0440\u043d."
                },
                "title": "INS Korean Polka Dots Dopamine Soft TPU Phone Case for iPhone 18 17 16 15 14 13 12 Pro Max 16E 17E 18 Pro Silicone Cream Cover",
                "rating": 4.9,
                "image_url": "https://ae-pic-a1.aliexpress-media.com/kf/S34be593b88f0488ca16b517948db9201i.jpg",
                "promotion": null,
                "sold_text": "3,000+ sold",
                "image_urls": [
                    "https://ae-pic-a1.aliexpress-media.com/kf/S34be593b88f0488ca16b517948db9201i.jpg",
                    "https://ae-pic-a1.aliexpress-media.com/kf/Se0a49749fe624caf9f121c76afd9aa6c7.jpg"
                ],
                "product_id": "1005012594256426",
                "sold_count": 3990,
                "is_sponsored": false,
                "original_price": {
                    "amount": 179.71,
                    "currency": "UAH",
                    "formatted": "179,71 \u0433\u0440\u043d."
                },
                "selling_points": [
                    "New shoppers save \u0433\u0440\u043d.125.85",
                    "Extra 2% off with coins"
                ],
                "discount_percent": 70
            },
            {
                "url": "https://www.aliexpress.com/item/1005010439419248.html",
                "price": {
                    "amount": 98.3,
                    "currency": "UAH",
                    "formatted": "98,30 \u0433\u0440\u043d."
                },
                "title": "Magnetic Original Clear Case For iPhone 17 16 15 14 Plus 13 12 Mini 11 Pro Max 16E 17E Funda For Magsafe Transparent Cover",
                "rating": 4.9,
                "image_url": "https://ae-pic-a1.aliexpress-media.com/kf/S28f397c19b0040ecac9bc4a3f73a9f123.jpg",
                "promotion": "\u0433\u0440\u043d.150 off on 3 items",
                "sold_text": "50,000+ sold",
                "image_urls": [
                    "https://ae-pic-a1.aliexpress-media.com/kf/S28f397c19b0040ecac9bc4a3f73a9f123.jpg",
                    "https://ae-pic-a1.aliexpress-media.com/kf/S7ba02a66503a44e981b6b60d8ab6ccccB.jpg"
                ],
                "product_id": "1005010439419248",
                "sold_count": 61612,
                "is_sponsored": false,
                "original_price": {
                    "amount": 278.95,
                    "currency": "UAH",
                    "formatted": "278,95 \u0433\u0440\u043d."
                },
                "selling_points": [],
                "discount_percent": 64
            }
        ],
        "has_more": true,
        "page_size": 60,
        "sort_options": [
            {
                "label": "Best matches",
                "value": "default"
            },
            {
                "label": "Popular",
                "value": "orders"
            }
        ],
        "total_results": 130348
    },
    "meta": {
        "billable": true,
        "endpoint_family": "search"
    },
    "success": true
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

422

Validation Error

A parameter is missing or invalid. This response is not billable.

{
    "errors": {
        "query": [
            "A search query is required, e.g. phone case."
        ]
    },
    "message": "The request validation failed"
}
503

Service Unavailable

AliExpress could not be reached. Retry after a short pause. This response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": true
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "AliExpress is temporarily unavailable. Please retry."
    },
    "success": false
}

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.