{
"openapi": "3.0.1",
"info": {
"title": "AliExpress Search Scraper - Prices, Sales & Ratings",
"description": "Scrape AliExpress search and category results: price, original price, discount, rating, units sold, Choice, free shipping, delivery estimate and images. Any country and currency, up to 3,600 products per search. Fast and reliable.",
"version": "0.1",
"x-build-id": "adPBQgDjXpTOtoU4s"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/dataspace~aliexpress-search-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-dataspace-aliexpress-search-scraper",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/acts/dataspace~aliexpress-search-scraper/runs": {
"post": {
"operationId": "runs-sync-dataspace-aliexpress-search-scraper",
"x-openai-isConsequential": false,
"summary": "Executes an Actor and returns information about the initiated run in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/runsResponseSchema"
}
}
}
}
}
}
},
"/acts/dataspace~aliexpress-search-scraper/run-sync": {
"post": {
"operationId": "run-sync-dataspace-aliexpress-search-scraper",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
}
},
"components": {
"schemas": {
"inputSchema": {
"type": "object",
"properties": {
"searchTerms": {
"title": "Search terms",
"type": "array",
"description": "Keywords to search on AliExpress, one per line (e.g. wireless earbuds, phone case). Each term is a separate search.",
"items": {
"type": "string"
}
},
"startUrls": {
"title": "AliExpress search or category URLs",
"type": "array",
"description": "Optional. Paste AliExpress search result or category page URLs (with your filters), e.g. https://www.aliexpress.com/category/100003109/women-clothing.html. Product pages are not supported.",
"items": {
"type": "string"
}
},
"maxItemsPerSearch": {
"title": "Max products per search",
"minimum": 1,
"maximum": 3600,
"type": "integer",
"description": "AliExpress shows up to 60 pages (3,600 products) per search.",
"default": 120
},
"sortBy": {
"title": "Sort by",
"enum": [
"default",
"orders",
"price_asc",
"price_desc",
"newest"
],
"type": "string",
"description": "Order of the results, like the sort options on AliExpress.",
"default": "default"
},
"minPrice": {
"title": "Min price",
"minimum": 0,
"type": "integer",
"description": "Only products from this price (in the selected currency)."
},
"maxPrice": {
"title": "Max price",
"minimum": 0,
"type": "integer",
"description": "Only products up to this price (in the selected currency)."
},
"includeSponsored": {
"title": "Include sponsored products",
"type": "boolean",
"description": "AliExpress mixes a few ads into the results. They are marked with isSponsored; switch off to skip them.",
"default": true
},
"includeNewShopperGifts": {
"title": "Include new-shopper gift cards",
"type": "boolean",
"description": "AliExpress shows logged-out visitors some 'FREE with any purchase' welcome-gift cards without a real price. They are skipped by default.",
"default": false
},
"shipTo": {
"title": "Ship to country",
"type": "string",
"description": "Two-letter country code (e.g. US, GB, DE, FR, TR). Prices, shipping and delivery estimates depend on it.",
"default": "US"
},
"currency": {
"title": "Currency",
"enum": [
"USD",
"EUR",
"GBP",
"CAD",
"AUD",
"JPY",
"KRW",
"BRL",
"MXN",
"PLN",
"TRY",
"CHF",
"SEK",
"NOK",
"DKK",
"CZK",
"HUF",
"ILS",
"SAR",
"AED",
"INR",
"NZD",
"CLP",
"COP",
"PEN",
"UAH",
"KZT",
"ZAR",
"SGD",
"MYR"
],
"type": "string",
"description": "Currency for all prices.",
"default": "USD"
},
"language": {
"title": "Language",
"type": "string",
"description": "Language of product titles, e.g. en_US, de_DE, fr_FR, es_ES, pt_BR.",
"default": "en_US"
},
"proxyConfiguration": {
"title": "Proxy configuration",
"type": "object",
"description": "Requests switch to a fresh proxy IP automatically if AliExpress shows a verification page.",
"default": {
"useApifyProxy": true
}
}
}
},
"runsResponseSchema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"actId": {
"type": "string"
},
"userId": {
"type": "string"
},
"startedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"finishedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"status": {
"type": "string",
"example": "READY"
},
"meta": {
"type": "object",
"properties": {
"origin": {
"type": "string",
"example": "API"
},
"userAgent": {
"type": "string"
}
}
},
"stats": {
"type": "object",
"properties": {
"inputBodyLen": {
"type": "integer",
"example": 2000
},
"rebootCount": {
"type": "integer",
"example": 0
},
"restartCount": {
"type": "integer",
"example": 0
},
"resurrectCount": {
"type": "integer",
"example": 0
},
"computeUnits": {
"type": "integer",
"example": 0
}
}
},
"options": {
"type": "object",
"properties": {
"build": {
"type": "string",
"example": "latest"
},
"timeoutSecs": {
"type": "integer",
"example": 300
},
"memoryMbytes": {
"type": "integer",
"example": 1024
},
"diskMbytes": {
"type": "integer",
"example": 2048
}
}
},
"buildId": {
"type": "string"
},
"defaultKeyValueStoreId": {
"type": "string"
},
"defaultDatasetId": {
"type": "string"
},
"defaultRequestQueueId": {
"type": "string"
},
"buildNumber": {
"type": "string",
"example": "1.0.0"
},
"containerUrl": {
"type": "string"
},
"usage": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "integer",
"example": 1
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
},
"PROXY_UNBLOCKER_UNITS": {
"type": "integer",
"example": 0
}
}
},
"usageTotalUsd": {
"type": "number",
"example": 0.00005
},
"usageUsd": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "number",
"example": 0.00005
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
},
"PROXY_UNBLOCKER_UNITS": {
"type": "integer",
"example": 0
}
}
}
}
}
}
}
}
}
}