Nexscope
🇺🇸 English
Start free

AliExpress Category Variants

Collect observed product variants from a public AliExpress category navigation URL. Submit a supported category URL in url; limit (1–100, default 20) bounds product groups, and one product may return several variant rows. The response provides a taskId. Poll GET /aliexpress/tasks/{taskId} with the same Nexscope API key to review the completed variant results.

CostAt least 10 credits / call
Try online
POST · https://api.nexscope.ai/aliexpress/categoryVariants

What this API does

Collect observed product variants from a public AliExpress category navigation URL. Submit a supported category URL in url; limit (1–100, default 20) bounds product groups, and one product may return several variant rows. The response provides a taskId. Poll GET /aliexpress/tasks/{taskId} with the same Nexscope API key to review the completed variant results. The request accepts url, limit. Generation runs as a task: retain the task ID and retrieve the completed result before using the output.

AliExpress Category Variants API use cases

Submit a AliExpress Category Variants request

Collect observed product variants from a public AliExpress category navigation URL. Submit a supported category URL in url; limit (1–100, default 20) bounds product groups, and one product may return several variant rows.

Retrieve the completed result

Keep the taskId from the initial response. Poll GET /aliexpress/tasks/{taskId} with the same Nexscope API key to review the completed variant results.

AliExpress Category Variants API FAQ

What does the AliExpress Category Variants API return?

Collect observed product variants discovered from a public AliExpress category navigation URL. The initial response includes a taskId and status. Use the task result endpoint to retrieve the completed result.

How many credits does the AliExpress Category Variants API cost?

Published rate: At least 10 credits / call. Actual credits depend on the request; review API usage records after completion. Looking up a task result does not start another collection.

How do I call the AliExpress Category Variants API?

Send a POST request to https://api.nexscope.ai/aliexpress/categoryVariants with your Nexscope API key in the Authorization Bearer header and the documented JSON inputs. Poll GET /aliexpress/tasks/{taskId} with the same Nexscope API key to review the completed variant results.

View plans and credits

Try this API
Endpoint
https://api.nexscope.ai/aliexpress/categoryVariants

Step 1 of 3 · Authenticate

Authentication

All run endpoints require a user API key. Send it as a bearer token in the Authorization header.

Authorization: Bearer nk-xxxxxxxxxxxxxxxxx
Missing or invalid API keys return an authentication error. Manage keys from .

Task result

Poll the returned task ID with the same Nexscope API key.

GET /aliexpress/tasks/{taskId}

Step 2 of 3 · Send a request

POSThttps://api.nexscope.ai/aliexpress/categoryVariants

Run an API

Send a JSON request body using the parameters described below.

Example request

Replace YOUR_API_KEY, then run this command in your terminal.

curl -X POST 'https://api.nexscope.ai/aliexpress/categoryVariants' \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://www.aliexpress.com/w/wholesale-Magic-Tricks-%26-Props.html?&osf=category_navigate&sg_search_params=scene_id=35917&recog_lang=en",
  "limit": 1
}'

Code example

{
  "url": "https://www.aliexpress.com/w/wholesale-Magic-Tricks-%26-Props.html?&osf=category_navigate&sg_search_params=scene_id=35917&recog_lang=en",
  "limit": 1
}

Step 3 of 3 · Inspect the result

Check the response

Read code for the request status and data for the result. Open the parameter and response reference for the full field definitions.

HTTP status codes

CodeDescription
200Default HTTP response for both success and many business errors. Only outer JSON code 0 indicates success or asynchronous acceptance; inspect data for the result.
429Execution admission rate limit; honor Retry-After when present.
503Execution admission is temporarily unavailable; honor Retry-After when present.
Opt-inX-Nexscope-Http-Status: semantic maps controller-handled business errors to HTTP status on run and task routes. Pre-authentication failures, such as a missing API key (code 11209), may still return HTTP 200 before this mapping. Always check the outer JSON code; malformed requests and infrastructure failures may also return non-200 HTTP responses.
All categories/ AliExpress
POSThttps://api.nexscope.ai/aliexpress/categoryVariants

Run this API

Send a JSON request to execute this API and receive the documented response payload.

Endpoint

MethodPOST
Pathhttps://api.nexscope.ai/aliexpress/categoryVariants
AuthBearer API key
Content-Typeapplication/json

Request parameters

NameTypeRequiredDescription
urlstringrequired
required supported AliExpress category navigation URL
limitintegeroptional
integer 1–100, default 20

Response example

Platform response envelope. code 0 indicates success or acceptance; data contains the business result.

{
  "code": 0,
  "data": {
    "taskId": "TASK_ID",
    "status": "SUBMITTING",
    "result": null,
    "usage": {
      "billingStatus": "PENDING",
      "chargedCredits": 0
    },
    "error": null
  }
}

Response fields

Response field reference (0 fields)

No required request fields are defined for this API.

Responses

CodeDescription
200Default HTTP response for both success and many business errors. Only outer JSON code 0 indicates success or asynchronous acceptance; inspect data for the result.
429Execution admission rate limit; honor Retry-After when present.
503Execution admission is temporarily unavailable; honor Retry-After when present.
Opt-inX-Nexscope-Http-Status: semantic maps controller-handled business errors to HTTP status on run and task routes. Pre-authentication failures, such as a missing API key (code 11209), may still return HTTP 200 before this mapping. Always check the outer JSON code; malformed requests and infrastructure failures may also return non-200 HTTP responses.

Data source, freshness, and limitations

Source, freshness, coverage, rate limits, and estimation notes are not specified in this API definition unless they appear in the request or response field documentation above. Do not assume official marketplace data or real-time freshness when it is not explicitly documented.

Data Example

Sample request and response

Request parameters

{
  "url": "https://www.aliexpress.com/w/wholesale-Magic-Tricks-%26-Props.html?&osf=category_navigate&sg_search_params=scene_id=35917&recog_lang=en",
  "limit": 1
}

Response

{
  "code": 0,
  "data": {
    "status": "SUCCEEDED",
    "result": {
      "items": [
        {
          "url": "https://www.aliexpress.us/item/1005008144724922.html",
          "productId": "1005008144724922",
          "title": "2/4/6pcs Magic Light Up Finger Fingers LED Tricks Thumb Props Christmas Christmas Festival Party Novelty Funny Toys",
          "images": [
            "https://ae-pic-a1.aliexpress-media.com/kf/Sa439ab62453846ae80fba37076c84b51M.jpg",
            "https://ae-pic-a1.aliexpress-media.com/kf/S48f97daf874247d0897b88a1a40f58f0j.jpg",
            "https://ae-pic-a1.aliexpress-media.com/kf/Sdf53f7d712f547d5b822367008e7f363I.jpg",
            "https://ae-pic-a1.aliexpress-media.com/kf/S31e298126e5a47288b26b28194a413b6z.jpg",
            "https://ae-pic-a1.aliexpress-media.com/kf/S6eac4e4e1f1e4aba88943cc47ae292106.jpg",
            "https://ae-pic-a1.aliexpress-media.com/kf/S6a36082e9be04090b865a1506bcfafacO.jpg",
            "https://ae-pic-a1.aliexpress-media.com/kf/S96870a3d50c145af9f509cc2963f2ffaA.jpg",
            "https://ae-pic-a1.aliexpress-media.com/kf/Sb53a28e2f2db40459b8f12a0e36c8eceN.jpg",
            "https://ae-pic-a1.aliexpress-media.com/kf/Sc0194804cf2f46a39104a3172ef14927e.jpg",
            "https://ae-pic-a1.aliexpress-media.com/kf/A216becd3745b46509fd9ed12b2961769W.jpg",
            "https://ae-pic-a1.aliexpress-media.com/kf/A1c7f6838675449b9a1c0a8947e3988d7n.jpg",
            "https://ae-pic-a1.aliexpress-media.com/kf/A7dc6b7e4322243edbdf73237dcbbf02eH.jpg"
          ],
          "price": null,
          "currency": null,
          "collectedAt": null,
          "missingFields": [
            "price",
            "currency",
            "collectedAt",
            "completeSkuMatrix"
          ],
          "variantId": "14-366",
          "availability": "in_stock",
          "listingHasVariations": true,
          "variantAttributes": [
            {
              "name": "Color",
              "value": "4Pcs"
            }
          ],
          "priceType": null,
          "variantGroups": [
            {
              "type": "Color",
              "options": [
                {
                  "id": "14-366",
                  "name": "4Pcs",
                  "price": null,
                  "inStock": null,
                  "image": "https://ae-pic-a1.aliexpress-media.com/kf/S96870a3d50c145af9f509cc2963f2ffaA.jpg_220x220q75.jpg_.avif"
                },
                {
                  "id": "14-29",
                  "name": "2Pcs",
                  "price": null,
                  "inStock": null,
                  "image": "https://ae-pic-a1.aliexpress-media.com/kf/Sb53a28e2f2db40459b8f12a0e36c8eceN.jpg_220x220q75.jpg_.avif"
                },
                {
                  "id": "14-193",
                  "name": "6Pcs",
                  "price": null,
                  "inStock": null,
                  "image": "https://ae-pic-a1.aliexpress-media.com/kf/Sc0194804cf2f46a39104a3172ef14927e.jpg_220x220q75.jpg_.avif"
                }
              ]
            }
          ]
        },
        {
          "url": "https://www.aliexpress.us/item/1005008144724922.html",
          "productId": "1005008144724922",
          "title": "2/4/6pcs Magic Light Up Finger Fingers LED Tricks Thumb Props Christmas Christmas Festival Party Novelty Funny Toys",
          "images": [
            "https://ae-pic-a1.aliexpress-media.com/kf/Sa439ab62453846ae80fba37076c84b51M.jpg",
            "https://ae-pic-a1.aliexpress-media.com/kf/S48f97daf874247d0897b88a1a40f58f0j.jpg",
            "https://ae-pic-a1.aliexpress-media.com/kf/Sdf53f7d712f547d5b822367008e7f363I.jpg",
            "https://ae-pic-a1.aliexpress-media.com/kf/S31e298126e5a47288b26b28194a413b6z.jpg",
            "https://ae-pic-a1.aliexpress-media.com/kf/S6eac4e4e1f1e4aba88943cc47ae292106.jpg",
            "https://ae-pic-a1.aliexpress-media.com/kf/S6a36082e9be04090b865a1506bcfafacO.jpg",
            "https://ae-pic-a1.aliexpress-media.com/kf/S96870a3d50c145af9f509cc2963f2ffaA.jpg",
            "https://ae-pic-a1.aliexpress-media.com/kf/Sb53a28e2f2db40459b8f12a0e36c8eceN.jpg",
            "https://ae-pic-a1.aliexpress-media.com/kf/Sc0194804cf2f46a39104a3172ef14927e.jpg",
            "https://ae-pic-a1.aliexpress-media.com/kf/A216becd3745b46509fd9ed12b2961769W.jpg",
            "https://ae-pic-a1.aliexpress-media.com/kf/A1c7f6838675449b9a1c0a8947e3988d7n.jpg",
            "https://ae-pic-a1.aliexpress-media.com/kf/A7dc6b7e4322243edbdf73237dcbbf02eH.jpg"
          ],
          "price": null,
          "currency": null,
          "collectedAt": null,
          "missingFields": [
            "price",
            "currency",
            "collectedAt",
            "completeSkuMatrix"
          ],
          "variantId": "14-193",
          "availability": "in_stock",
          "listingHasVariations": true,
          "variantAttributes": [
            {
              "name": "Color",
              "value": "6Pcs"
            }
          ],
          "priceType": null,
          "variantGroups": [
            {
              "type": "Color",
              "options": [
                {
                  "id": "14-366",
                  "name": "4Pcs",
                  "price": null,
                  "inStock": null,
                  "image": "https://ae-pic-a1.aliexpress-media.com/kf/S96870a3d50c145af9f509cc2963f2ffaA.jpg_220x220q75.jpg_.avif"
                },
                {
                  "id": "14-29",
                  "name": "2Pcs",
                  "price": null,
                  "inStock": null,
                  "image": "https://ae-pic-a1.aliexpress-media.com/kf/Sb53a28e2f2db40459b8f12a0e36c8eceN.jpg_220x220q75.jpg_.avif"
                },
                {
                  "id": "14-193",
                  "name": "6Pcs",
                  "price": null,
                  "inStock": null,
                  "image": "https://ae-pic-a1.aliexpress-media.com/kf/Sc0194804cf2f46a39104a3172ef14927e.jpg_220x220q75.jpg_.avif"
                }
              ]
            }
          ]
        },
        {
          "url": "https://www.aliexpress.us/item/1005008144724922.html",
          "productId": "1005008144724922",
          "title": "2/4/6pcs Magic Light Up Finger Fingers LED Tricks Thumb Props Christmas Christmas Festival Party Novelty Funny Toys",
          "images": [
            "https://ae-pic-a1.aliexpress-media.com/kf/Sa439ab62453846ae80fba37076c84b51M.jpg",
            "https://ae-pic-a1.aliexpress-media.com/kf/S48f97daf874247d0897b88a1a40f58f0j.jpg",
            "https://ae-pic-a1.aliexpress-media.com/kf/Sdf53f7d712f547d5b822367008e7f363I.jpg",
            "https://ae-pic-a1.aliexpress-media.com/kf/S31e298126e5a47288b26b28194a413b6z.jpg",
            "https://ae-pic-a1.aliexpress-media.com/kf/S6eac4e4e1f1e4aba88943cc47ae292106.jpg",
            "https://ae-pic-a1.aliexpress-media.com/kf/S6a36082e9be04090b865a1506bcfafacO.jpg",
            "https://ae-pic-a1.aliexpress-media.com/kf/S96870a3d50c145af9f509cc2963f2ffaA.jpg",
            "https://ae-pic-a1.aliexpress-media.com/kf/Sb53a28e2f2db40459b8f12a0e36c8eceN.jpg",
            "https://ae-pic-a1.aliexpress-media.com/kf/Sc0194804cf2f46a39104a3172ef14927e.jpg",
            "https://ae-pic-a1.aliexpress-media.com/kf/A216becd3745b46509fd9ed12b2961769W.jpg",
            "https://ae-pic-a1.aliexpress-media.com/kf/A1c7f6838675449b9a1c0a8947e3988d7n.jpg",
            "https://ae-pic-a1.aliexpress-media.com/kf/A7dc6b7e4322243edbdf73237dcbbf02eH.jpg"
          ],
          "price": null,
          "currency": null,
          "collectedAt": null,
          "missingFields": [
            "price",
            "currency",
            "collectedAt",
            "completeSkuMatrix"
          ],
          "variantId": "14-29",
          "availability": "in_stock",
          "listingHasVariations": true,
          "variantAttributes": [
            {
              "name": "Color",
              "value": "2Pcs"
            }
          ],
          "priceType": null,
          "variantGroups": [
            {
              "type": "Color",
              "options": [
                {
                  "id": "14-366",
                  "name": "4Pcs",
                  "price": null,
                  "inStock": null,
                  "image": "https://ae-pic-a1.aliexpress-media.com/kf/S96870a3d50c145af9f509cc2963f2ffaA.jpg_220x220q75.jpg_.avif"
                },
                {
                  "id": "14-29",
                  "name": "2Pcs",
                  "price": null,
                  "inStock": null,
                  "image": "https://ae-pic-a1.aliexpress-media.com/kf/Sb53a28e2f2db40459b8f12a0e36c8eceN.jpg_220x220q75.jpg_.avif"
                },
                {
                  "id": "14-193",
                  "name": "6Pcs",
                  "price": null,
                  "inStock": null,
                  "image": "https://ae-pic-a1.aliexpress-media.com/kf/Sc0194804cf2f46a39104a3172ef14927e.jpg_220x220q75.jpg_.avif"
                }
              ]
            }
          ]
        }
      ],
      "discovered": [],
      "variantCoverage": "ALL_REQUESTED_UNVERIFIED",
      "limitReached": true,
      "errorRecords": 0
    }
  }
}

Online test

Execute the current API with your API key and JSON payload. Online tests use this site's configured API environment; the Endpoint and copyable examples use the public integration address.

Submitting a request can use credits. The task result lookup does not submit the request again. Review the final charge in API usage records.

At least 10 credits / callAPI usage records

Try it

Send a real request with the same contract shown in the reference.

Endpoint
/aliexpress/categoryVariants
Task result endpoint
/aliexpress/tasks/{taskId}
cURL
curl -X POST \
  https://api.nexscope.ai/aliexpress/categoryVariants \
  -H "Authorization: Bearer nk-..." \
  -H "Content-Type: application/json" \
  -d '{ "url": "https://www.aliexpress.com/w/wholesale-Magic-Tricks-%26-Props.html?&osf=category_navigate&sg_search_params=scene_id=35917&recog_lang=en", "limit": 1 }'
Response
No response yet. Run the request to see the response here.
Task result

Results are checked automatically after Run request. You can also enter a task ID and check it manually; completed resources use Nexscope URLs and show actual charged credits.

Result response
No task result yet. Query the task to see the generated output here.

Related APIs