API reference

AliExpress Product API

One AliExpress product: title, price range and promotion, rating, sales, images and video, properties, description, variants and options, shipping options and the seller.

Read as Markdown Use with an AI agent

Endpoint

GET/v1/aliexpress/productlive · proven3 credits

Try in Playground

Parameters

Query parameters

Name	Required	Description	Example
`id`	yes	AliExpress item id (the number in its URL), or the URL	`1005005244562338`
`region`	no	Storefront country	`US`
`currency`	no	Currency code	`USD`
`language`	no	Locale	`en_US`
`dry_run`	no	Read 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/product?id=1005005244562338" \
  -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/product?id=1005005244562338",
  { 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/product?id=1005005244562338",
    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/product",
  "data": {
    "available": false,
    "breadcrumbs": [],
    "category_id": "example",
    "currency": "example",
    "description": {
      "images": [
        "example"
      ]
    },
    "id": "example",
    "image": "https://example.com/example",
    "images": [
      "example"
    ],
    "options": [
      {
        "id": "example",
        "name": "example",
        "values": [
          {}
        ]
      }
    ],
    "platform": "example",
    "price_range": {
      "max": 0,
      "min": 0
    },
    "promotion_price": {
      "max": 0,
      "min": 0
    },
    "properties": [
      {
        "name": "example",
        "value": "example"
      }
    ],
    "quantity": 0,
    "rating": {
      "max": 0,
      "value": 0,
      "votes": 0
    },
    "reviews_count": 0,
    "seller": {
      "company_id": "example",
      "id": "example",
      "name": "example",
      "store_id": "example",
      "url": "https://example.com/example"
    },
    "shipping": {
      "days_to_ship": 0,
      "options": [],
      "package": {
        "height": 0,
        "length": 0,
        "weight": 0,
        "width": 0
      },
      "to": "example"
    },
    "title": "example",
    "type": "example",
    "url": "https://example.com/example",
    "variants": [
      {
        "attributes": "example",
        "ext": "example",
        "id": "example",
        "price": 0,
        "promotion_price": 0,
        "quantity": 0
      }
    ]
  },
  "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 data	Type	Meaning
`available`	`boolean \| null`	Optional available supplied by this operation. Null means unknown.
`breadcrumbs`	`array \| null`	Source array was empty in the reviewed captures; item fields remain unspecified.
`category_id`	`string \| null`	Optional category id supplied by this operation. Null means unknown.
`currency`	`string \| null`	Optional currency supplied by this operation. Null means unknown.
`description`	`object \| null`	Source description; null or absent means not supplied.
`description.images`	`array \| null`	Optional images supplied by this operation. Null means unknown.
`id`	`string \| null`	Source identifier. Preserve the supplied type and exact value.
`image`	`string \| null`	Optional image supplied by this operation. Null means unknown.
`images`	`array \| null`	Optional images supplied by this operation. Null means unknown.
`options`	`array \| null`	Optional options supplied by this operation. Null means unknown.
`options[].id`	`string \| null`	Source identifier. Preserve the supplied type and exact value.
`options[].name`	`string \| null`	Optional name supplied by this operation. Null means unknown.
`options[].values`	`array \| null`	Optional values supplied by this operation. Null means unknown.
`platform`	`string \| null`	Optional platform supplied by this operation. Null means unknown.
`price_range`	`object \| null`	Optional price range supplied by this operation. Null means unknown.
`price_range.max`	`number \| null`	Optional max supplied by this operation. Null means unknown.
`price_range.min`	`number \| null`	Optional min supplied by this operation. Null means unknown.
`promotion_price`	`object \| null`	Optional promotion price supplied by this operation. Null means unknown.
`promotion_price.max`	`number \| null`	Optional max supplied by this operation. Null means unknown.
`promotion_price.min`	`number \| null`	Optional min supplied by this operation. Null means unknown.
`properties`	`array \| null`	Optional properties supplied by this operation. Null means unknown.
`properties[].name`	`string \| null`	Optional name supplied by this operation. Null means unknown.
`properties[].value`	`string \| null`	Optional value supplied by this operation. Null means unknown.
`quantity`	`number \| null`	Optional quantity supplied by this operation. Null means unknown.
`rating`	`object \| null`	Source rating; read its accompanying scale and vote count.
`rating.max`	`number \| null`	Optional max supplied by this operation. Null means unknown.
`rating.value`	`number \| null`	Optional value supplied by this operation. Null means unknown.
`rating.votes`	`number \| null`	Optional votes supplied by this operation. Null means unknown.
`reviews_count`	`number \| null`	Optional reviews count supplied by this operation. Null means unknown.
`seller`	`object \| null`	Optional seller supplied by this operation. Null means unknown.
`seller.company_id`	`string \| null`	Optional company id supplied by this operation. Null means unknown.
`seller.id`	`string \| null`	Source identifier. Preserve the supplied type and exact value.
`seller.name`	`string \| null`	Optional name supplied by this operation. Null means unknown.
`seller.store_id`	`string \| null`	Optional store id supplied by this operation. Null means unknown.
`seller.url`	`string \| null`	Original source URL when supplied.
`shipping`	`object \| null`	Optional shipping supplied by this operation. Null means unknown.
`shipping.days_to_ship`	`number \| null`	Optional days to ship supplied by this operation. Null means unknown.
`shipping.options`	`array \| null`	Source array was empty in the reviewed captures; item fields remain unspecified.
`shipping.package`	`object \| null`	Optional package supplied by this operation. Null means unknown.
`shipping.package.height`	`number \| null`	Optional height supplied by this operation. Null means unknown.
`shipping.package.length`	`number \| null`	Optional length supplied by this operation. Null means unknown.
`shipping.package.weight`	`number \| null`	Optional weight supplied by this operation. Null means unknown.
`shipping.package.width`	`number \| null`	Optional width supplied by this operation. Null means unknown.
`shipping.to`	`string \| null`	Optional to supplied by this operation. Null means unknown.
`title`	`string \| null`	Source title when supplied.
`type`	`string \| null`	Optional type supplied by this operation. Null means unknown.
`url`	`string \| null`	Original source URL when supplied.
`variants`	`array \| null`	Optional variants supplied by this operation. Null means unknown.
`variants[].attributes`	`string \| null`	Optional attributes supplied by this operation. Null means unknown.
`variants[].ext`	`string \| null`	Optional ext supplied by this operation. Null means unknown.
`variants[].id`	`string \| null`	Source identifier. Preserve the supplied type and exact value.
`variants[].price`	`number \| null`	Source price. Currency, taxes and availability depend on the listing.
`variants[].promotion_price`	`number \| null`	Optional promotion price supplied by this operation. Null means unknown.
`variants[].quantity`	`number \| null`	Optional quantity 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

AliExpress Product API

Query parameters

Make the request

Response fields and example

More AliExpress reference

First call in under a minute