API reference
AliExpress Product Description API
The full description text and images of an AliExpress product, with its property list.
Endpoint
/v1/aliexpress/descriptionlive · proven1 creditParameters
Query parameters
| Name | Required | Description | Example |
|---|---|---|---|
id | yes | AliExpress item id | 1005005244562338 |
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 "https://www.monocrawl.com/v1/aliexpress/description?id=1005005244562338" \ -H "x-api-key: mn_your_key_here"
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/description?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
import os
import requests
res = requests.get(
"https://www.monocrawl.com/v1/aliexpress/description?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.
{
"success": true,
"platform": "aliexpress",
"endpoint": "/v1/aliexpress/description",
"data": {
"description": {
"images": [
"example"
],
"text": "example"
},
"id": "example",
"platform": "example",
"properties": [
{
"name": "example",
"value": "example"
}
]
},
"credits_used": 1,
"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 |
|---|---|---|
description | object | null | Source description; null or absent means not supplied. |
description.images | array | null | Optional images supplied by this operation. Null means unknown. |
description.text | string | null | Source text when supplied. |
id | string | null | Source identifier. Preserve the supplied type and exact value. |
platform | string | null | Optional platform 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. |
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