{ "openapi": "3.0.1", "info": { "title": "AliExpress Scraper", "description": "Effortlessly extract descriptions, images, feedback, questions, prices, and shipping information from AliExpress. Customize country, language, and region preferences for enhanced data gathering.", "version": "1.0", "x-build-id": "fIRkaGIDJMdgOXTVw" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/epctex~aliexpress-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-epctex-aliexpress-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/epctex~aliexpress-scraper/runs": { "post": { "operationId": "runs-sync-epctex-aliexpress-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/epctex~aliexpress-scraper/run-sync": { "post": { "operationId": "run-sync-epctex-aliexpress-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", "required": [ "proxy" ], "properties": { "startUrls": { "title": "StartURLs", "type": "array", "description": "URLs for the scraper to start from - these should be category or product detail URLs", "items": { "type": "string" } }, "maxItems": { "title": "Max items", "type": "integer", "description": "Set the maximum number of items to crawl per run" }, "searchTerms": { "title": "Search terms", "uniqueItems": true, "type": "array", "description": "Search terms to use for full-text search in AliExpress page", "items": { "type": "string" } }, "searchInSubcategories": { "title": "Search in subcategories", "type": "boolean", "description": "Tells the scraper whether it should also scrape subcategories", "default": true }, "language": { "title": "Language", "enum": [ "en_US", "ru_RU", "pt_BR", "es_ES", "fr_FR", "pl_PL", "iw_IL", "it_IT", "tr_TR", "de_DE", "ko_KR", "ar_MA", "ja_JP", "nl_NL", "th_TH", "vi_VN", "in_ID" ], "type": "string", "description": "Select your language", "default": "en_US" }, "shipTo": { "title": "Shipping to", "enum": [ "AF", "ALA", "AL", "GBA", "DZ", "AS", "AD", "AO", "AI", "AG", "AR", "AM", "AW", "ASC", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BR", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "BQ", "KY", "CF", "TD", "CL", "CX", "CC", "CO", "KM", "ZR", "CG", "CK", "CR", "CI", "HR", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GGY", "GN", "GW", "GY", "HT", "HN", "HK", "HU", "IS", "IN", "ID", "IQ", "IE", "IL", "IT", "JM", "JP", "JEY", "JO", "KZ", "KE", "KI", "KR", "KS", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "MNE", "MS", "MA", "MZ", "MM", "NA", "NR", "BN", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "OTHER", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BLM", "KN", "LC", "MAF", "VC", "WS", "SM", "ST", "SA", "SN", "SRB", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "SGS", "SS", "ES", "LK", "PM", "SR", "SZ", "SE", "CH", "TW", "TJ", "TZ", "TH", "TLS", "TG", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "UK", "US", "UY", "UZ", "VU", "VA", "VE", "VN", "VG", "VI", "WF", "YE", "ZM", "EAZ", "ZW" ], "type": "string", "description": "Select your country", "default": "US" }, "currency": { "title": "Currency", "enum": [ "USD", "AFN", "EUR", "ALL", "AOA", "XCD", "AMD", "AWG", "SHP", "AUD", "AZN", "BSD", "BHD", "BDT", "BYR", "BZD", "XOF", "BMD", "BTN", "BAM", "BWP", "NOK", "BRL", "BND", "BGN", "BIF", "KHR", "XAF", "CAD", "CVE", "KYD", "CLP", "KMF", "CDF", "NZD", "CRC", "CZK", "DKK", "DJF", "DOP", "EGP", "SVC", "ERN", "XPF", "NIO", "NGN", "OMR", "PKR", "PGK", "PYG", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "WST", "STD", "SAR", "RSD", "SCR", "SLL", "SGD", "SBD", "SOS", "ZAR", "KRW", "LKR", "SRD", "SZL", "SEK", "CHF", "TWD", "TJS", "TZS", "THB", "TOP", "TTD", "TND", "TRY", "TMT", "UGX", "UAH", "AED", "GBP", "UYU", "UZS", "VUV", "VND", "YER", "ZMW", "ZWL", "ETB", "FKP", "FJD", "GMD", "GEL", "GHS", "GIP", "GTQ", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IQD", "ILS", "JMD", "JPY", "KZT", "KES", "KWD", "KGS", "LAK", "LBP", "LSL", "LRD", "LYD", "MOP", "MKD", "MWK", "MYR", "MVR", "MUR", "MXN", "MDL", "MNT", "MAD", "MZN", "MMK", "NAD", "NPR", "ARS", "PEN", "DZD", "JOD", "BOB", "COP", "BBD", "PAB", "HRK" ], "type": "string", "description": "Select your currency", "default": "USD" }, "includeDescription": { "title": "Description", "type": "boolean", "description": "Include description for products - note that this might slightly slow down the scraper", "default": false }, "maxFeedbacks": { "title": "Max feedback count", "type": "integer", "description": "Set maximum number of feedback entries", "default": 0 }, "maxQuestions": { "title": "Max question and answers count", "type": "integer", "description": "Set maximum number of scraped Q&A entries", "default": 0 }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Select proxies to be used by your crawler", "default": { "useApifyProxy": true } }, "extendOutputFunction": { "title": "Extend output function", "type": "string", "description": "Function that takes a JQuery handle ($) as argument and returns data that will be merged with the default output" } } }, "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 } } }, "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 } } } } } } } } } }