{ "openapi": "3.0.1", "info": { "title": "AliExpress Search Scraper: Prices, Sold Count & Rank", "description": "AliExpress search scraper for any keyword or category URL. Get search rank, product ID, price, original price, discount, rating, exact sold count, store, ship-from country, Choice and free shipping flags. Pick any ship-to country and currency. $1 per 1,000 results. Export CSV/JSON or use the API.", "version": "0.1", "x-build-id": "hqh3sRSh3YELDkKcq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jaaylee~aliexpress-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jaaylee-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/jaaylee~aliexpress-search-scraper/runs": { "post": { "operationId": "runs-sync-jaaylee-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/jaaylee~aliexpress-search-scraper/run-sync": { "post": { "operationId": "run-sync-jaaylee-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", "required": [ "searchTerms" ], "properties": { "searchTerms": { "title": "Search keywords or URLs", "type": "array", "description": "Keywords to search on AliExpress (e.g. phone case), or aliexpress.com search result (/w/wholesale-...) or category (/category/...) URLs with your filters. One per line. Duplicates are removed.", "items": { "type": "string" } }, "maxPagesPerSearch": { "title": "Pages per search", "minimum": 1, "maximum": 60, "type": "integer", "description": "How many result pages to scrape for each search (AliExpress shows up to 60 results per page and up to 60 pages).", "default": 1 }, "sort": { "title": "Sort by", "enum": [ "relevance", "bestsellers", "price-asc", "price-desc" ], "type": "string", "description": "Result order, as in AliExpress's 'Sort by' bar. Ignored for URLs that already contain a sort.", "default": "relevance" }, "shipTo": { "title": "Ship to country", "pattern": "^[A-Za-z]{2}$", "type": "string", "description": "2-letter country code (US, GB, DE, FR, CA, AU, ...). AliExpress shows prices, local-warehouse items and delivery estimates for this country.", "default": "US" }, "currency": { "title": "Currency", "pattern": "^[A-Za-z]{3}$", "type": "string", "description": "3-letter currency code for prices (USD, EUR, GBP, CAD, AUD, ...).", "default": "USD" }, "minPrice": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Optional. Only results priced at or above this amount, in the selected currency." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Optional. Only results priced at or below this amount, in the selected currency." }, "maxItems": { "title": "Max results in total", "minimum": 1, "type": "integer", "description": "Optional. Stop after this many results across all searches (useful to cap cost)." }, "maxItemsPerSearch": { "title": "Max results per search", "minimum": 1, "type": "integer", "description": "Optional. Stop each search after this many results." }, "includeSponsored": { "title": "Include sponsored results", "type": "boolean", "description": "Keep results marked as ads. Turn off to get organic results only (organic rank is in organicPositionOnPage either way).", "default": true }, "skipDuplicates": { "title": "Skip repeated products", "type": "boolean", "description": "AliExpress repeats some products on later result pages. Keep only the first appearance of each product per search (its rank stays as shown). Skipped repeats are not charged.", "default": true }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many searches run in parallel. Pages of one search are fetched in order so the overall rank is exact.", "default": 5 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Primary proxy. The default Apify datacenter proxy works for AliExpress search pages.", "default": { "useApifyProxy": true } }, "residentialFallback": { "title": "Retry blocked pages with residential proxy", "type": "boolean", "description": "If a page stays blocked after 3 attempts on the primary proxy, retry it up to 2 more times through US residential proxies. Off by default because the datacenter proxy has been reliable. Blocked pages are never charged.", "default": false }, "failOnLowQuality": { "title": "Fail run on low data quality (monitoring)", "type": "boolean", "description": "For monitoring tasks: mark the run as failed when fewer than 80% of pages succeed or key fields are missing.", "default": false } } }, "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 } } } } } } } } } }