{ "openapi": "3.0.1", "info": { "title": "AliExpress Product Details Scraper & AliExpress Scraper API", "description": "AliExpress product data by product URL or item id, no login: price, original price and stock for every SKU, product variants with images, AliExpress shipping to your country with carrier, fee and dates, store and seller ids, rating, review count, orders sold, images, video, specs, category.", "version": "0.1", "x-build-id": "CubggPKtln605DEx0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/hyperbach~aliexpress-product-details-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-hyperbach-aliexpress-product-details-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/hyperbach~aliexpress-product-details-scraper/runs": { "post": { "operationId": "runs-sync-hyperbach-aliexpress-product-details-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/hyperbach~aliexpress-product-details-scraper/run-sync": { "post": { "operationId": "run-sync-hyperbach-aliexpress-product-details-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": { "products": { "title": "Products: URLs or item ids", "type": "array", "description": "One product per line, as a product URL on any AliExpress site (`https://www.aliexpress.com/item/1005009383937691.html`, `aliexpress.us/item/3256809197622939.html`, `de.aliexpress.com/item/…`) or as a bare item id (`1005009383937691`). The same product given several ways is one row. A value that is not a product (a search, category or store URL, a share link, a typo) gets a free row that says why.", "default": [], "items": { "type": "string" } }, "shipTo": { "title": "Ship-to country", "pattern": "^[A-Za-z]{2}$", "type": "string", "description": "The two-letter country the products are read for (`US`, `GB`, `DE`, `BR`, …): prices, stock, availability and the shipping options are the ones a shopper there sees. A product the store does not ship there comes back with its full record and `shipping_status` = `not_shippable`; a product not sold there at all is a free `unavailable` row.", "default": "US" }, "shipToCountries": { "title": "Also read each product for these countries", "type": "array", "description": "Compare one product across markets: each product is also read for every country listed here (two-letter codes), one row per product and country, each in that country's own currency unless `currency` is set. Empty = the ship-to country above only.", "items": { "type": "string", "pattern": "^[A-Za-z]{2}$" }, "default": [] }, "currency": { "title": "Currency", "pattern": "^([A-Za-z]{3})?$", "type": "string", "description": "A three-letter currency code for every price (`USD`, `EUR`, `GBP`, `BRL`, …). Empty = each row in its ship-to country's own currency (USD for US, GBP for GB, EUR for DE, …); the row says which one it used.", "default": "" }, "language": { "title": "Language", "pattern": "^[a-z]{2}_[A-Z]{2}$", "type": "string", "description": "The locale of the texts (title, specifications, attribute names, shipping and service lines): `en_US`, `de_DE`, `es_ES`, `fr_FR`, `pt_BR`, `ru_RU`, …", "default": "en_US" }, "includeDescription": { "title": "Description text and images", "type": "boolean", "description": "Read the product's description file (one more small call per product) and add its text and image links to the row (`description_text`, `description_images`). The signed description links are on every row either way.", "default": false }, "maxItems": { "title": "Max product records", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Stop after this many product records (charged rows; the free rows of misses do not count). 0 = no cap.", "default": 0 } } }, "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 } } } } } } } } } }