AliExpress API

Similar AliExpress products

Products similar to an AliExpress product (or to a keyword), from the marketplace's own matching.

Endpoint

GET/v1/aliexpress/similarlimited capacity3 credits
Try in Playground

Limited capacity: this operation currently relies on small shared monthly allowances. Availability can end before your account credits are used. Contact support before scheduling or bulk use. Allowances are shared across customers and related operations; this is not a per-account entitlement.

Parameters

Query parameters

NameRequiredDescriptionExample
product_idnoA product id or URL3256806145778732
querynoA keyword, when no product id is givenheadphones
countrynoShip-to countryUS
currencynoPrice currencyUSD
dry_runnoRead a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution.1

Examples

Make the request

curl
curl "https://www.monocrawl.com/v1/aliexpress/similar?query=headphones" \
  -H "x-api-key: mn_your_key_here"
TypeScript
typescript
const key = process.env.MONOCRAWL_API_KEY;
if (!key) throw new Error('Set MONOCRAWL_API_KEY on your server.');
const res = await fetch(
  "https://www.monocrawl.com/v1/aliexpress/similar?query=headphones",
  { headers: { "x-api-key": key } },
);
const body = await res.json();

if (!body.success) {
  // one error shape for every endpoint — see /docs/errors
  throw new Error(`${body.error.type}: ${body.error.message}`);
}

console.log(body.data, "credits left:", body.credits_remaining);
Python
python
import os
import requests

res = requests.get(
    "https://www.monocrawl.com/v1/aliexpress/similar?query=headphones",
    headers={"x-api-key": os.environ["MONOCRAWL_API_KEY"]},
    timeout=60,
)
body = res.json()

if not body["success"]:
    # one error shape for every endpoint — see /docs/errors
    raise RuntimeError(f"{body['error']['type']}: {body['error']['message']}")

print(body["data"], "credits left:", body["credits_remaining"])

Response

Response fields and example

This example is illustrative, not a captured live response. Variable-cost operations may settle a charge different from the list price below. A successful response puts the platform payload in data and reports the exact credits used, remaining balance, request id and cache status beside it.

200 · application/json
{
  "success": true,
  "platform": "aliexpress",
  "endpoint": "/v1/aliexpress/similar",
  "data": {
    "count": 0,
    "has_more": false,
    "items": [
      {
        "category": {
          "id": "example",
          "name": "example",
          "parent": "example"
        },
        "currency": "example",
        "discount": "example",
        "id": "example",
        "image": "https://example.com/example",
        "images": [
          "example"
        ],
        "original_price": 0,
        "platform": "example",
        "price": 0,
        "promotion_price": 0,
        "rating": {
          "max": 0,
          "value": 0
        },
        "sales": 0,
        "sales_label": "example",
        "selling_points": [],
        "shop": {
          "id": "example",
          "name": "example",
          "url": "https://example.com/example"
        },
        "sku_id": "example",
        "title": "example",
        "type": "example",
        "url": "https://example.com/example",
        "video_url": "https://example.com/example"
      }
    ],
    "page": 0,
    "source_product_id": "example"
  },
  "credits_used": 3,
  "credits_remaining": 99,
  "request_id": "req_…",
  "cached": false
}

The example is illustrative and shows a documented subset of data. The fields below are optional across supported sources; nullable fields can also be absent. Preserve unknown values and accept additional fields.

Schema basis: observed response shapes, not an exhaustive field specification. See schema coverage and validation limits.

Download the data JSON Schema. Validate response.data, not the whole envelope. A valid shape does not establish that every field or source record was returned.

Field inside dataTypeMeaning
countnumber | nullNumber of records in this response, not lifetime or total matches.
has_moreboolean | nullSource continuation indicator; null means unknown.
itemsarray | nullReturned records. Source coverage and completeness vary.
items[].categoryobject | nullOptional category supplied by this operation. Null means unknown.
items[].category.idstring | nullSource identifier. Preserve the supplied type and exact value.
items[].category.namestring | nullOptional name supplied by this operation. Null means unknown.
items[].category.parentstring | nullOptional parent supplied by this operation. Null means unknown.
items[].currencystring | nullOptional currency supplied by this operation. Null means unknown.
items[].discountstring | nullOptional discount supplied by this operation. Null means unknown.
items[].idstring | nullSource identifier. Preserve the supplied type and exact value.
items[].imagestring | nullOptional image supplied by this operation. Null means unknown.
items[].imagesarray | nullOptional images supplied by this operation. Null means unknown.
items[].original_pricenumber | nullOptional original price supplied by this operation. Null means unknown.
items[].platformstring | nullOptional platform supplied by this operation. Null means unknown.
items[].pricenumber | nullSource price. Currency, taxes and availability depend on the listing.
items[].promotion_pricenumber | nullOptional promotion price supplied by this operation. Null means unknown.
items[].ratingobject | nullSource rating; read its accompanying scale and vote count.
items[].rating.maxnumber | nullOptional max supplied by this operation. Null means unknown.
items[].rating.valuenumber | nullOptional value supplied by this operation. Null means unknown.
items[].salesnumber | nullOptional sales supplied by this operation. Null means unknown.
items[].sales_labelstring | nullOptional sales label supplied by this operation. Null means unknown.
items[].selling_pointsarray | nullSource array was empty in the reviewed captures; item fields remain unspecified.
items[].shopobject | nullOptional shop supplied by this operation. Null means unknown.
items[].shop.idstring | nullSource identifier. Preserve the supplied type and exact value.
items[].shop.namestring | nullOptional name supplied by this operation. Null means unknown.
items[].shop.urlstring | nullOriginal source URL when supplied.
items[].sku_idstring | nullOptional sku id supplied by this operation. Null means unknown.
items[].titlestring | nullSource title when supplied.
items[].typestring | nullOptional type supplied by this operation. Null means unknown.
items[].urlstring | nullOriginal source URL when supplied.
items[].video_urlstring | nullOptional video url supplied by this operation. Null means unknown.
pagenumber | nullOptional page supplied by this operation. Null means unknown.
source_product_idstring | nullOptional source product id supplied by this operation. Null means unknown.

Optional fields reviewed from preserved successful responses. Additive fields and source variations remain allowed; validate the fields your workflow requires.

The example is invented and illustrates types only; zero and empty values are not claims about a real result.

Failures use the typed error envelope. A confirmed uncharged or refunded failure reports zero; a pending reconciliation can report an unknown charge. Read credits_used and error.details.billing_status, and keep request_id for recovery. Response contract · Error reference

First call in under a minute

1,000 monthly free credits and a ready-made key the moment you sign up. No card.