{
"openapi": "3.0.1",
"info": {
"title": "Price Comparison: AliExpress, eBay, Walmart, Etsy",
"description": "Product price comparison across AliExpress, eBay, Walmart and Etsy in one run: one keyword, one table with the same columns everywhere (price, currency, shipping, rating, sales, marketplace, rank) and a summary of the lowest, median and highest price per marketplace. No personal data.",
"version": "0.1",
"x-build-id": "VOfbMr1x3Ts1ora3u"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/myth84~marketplace-price-compare-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-myth84-marketplace-price-compare-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/myth84~marketplace-price-compare-scraper/runs": {
"post": {
"operationId": "runs-sync-myth84-marketplace-price-compare-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/myth84~marketplace-price-compare-scraper/run-sync": {
"post": {
"operationId": "run-sync-myth84-marketplace-price-compare-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": {
"searchQueries": {
"title": "Search keywords",
"type": "array",
"description": "Product words to search on every marketplace, one search per line, e.g. wireless earbuds or air fryer. Each keyword is compared separately; duplicates are searched once. Etsy only has results for common product words (e.g. ceramic mug). Default wireless earbuds: a product found on AliExpress, eBay and Walmart, so a run without keywords still gives a full comparison.",
"default": [
"wireless earbuds"
],
"items": {
"type": "string"
}
},
"marketplaces": {
"title": "Marketplaces",
"uniqueItems": true,
"type": "array",
"description": "Marketplaces to search, all in the same run. Default: AliExpress, eBay and Walmart, which have results for any product keyword. Add Etsy for handmade, vintage and gift products.",
"items": {
"type": "string",
"enum": [
"aliexpress",
"ebay",
"walmart",
"etsy"
],
"enumTitles": [
"AliExpress",
"eBay (fixed-price listings)",
"Walmart (US and Canada only)",
"Etsy"
]
},
"default": [
"aliexpress",
"ebay",
"walmart"
]
},
"maxResultsPerMarketplace": {
"title": "Products per marketplace",
"minimum": 1,
"maximum": 500,
"type": "integer",
"description": "Products returned per keyword and per marketplace, in each marketplace's own best-match order, from 1 to 500; you are never charged for more than keywords × marketplaces × this number. Default 20: enough products per marketplace for a meaningful lowest, median and highest price. The form is prefilled with 10 for a quick first run.",
"default": 20
},
"country": {
"title": "Country",
"enum": [
"US",
"GB",
"CA",
"AU",
"DE",
"FR",
"IT",
"ES",
"NL",
"IE"
],
"type": "string",
"description": "Country to compare prices for: the eBay, Walmart and Etsy site of that country, and AliExpress shipping to it. A marketplace without a site for the country (Walmart outside the US and Canada) is skipped and says so in the log and the summary. Default US: the only country whose four sites (AliExpress shipping, ebay.com, walmart.com, etsy.com) were all verified when this Actor was built.",
"default": "US"
},
"currency": {
"title": "Currency",
"pattern": "^[A-Za-z]{3}$",
"type": "string",
"description": "ISO currency code to compare prices in, e.g. USD. Leave empty for the currency of the country (USD for the United States). AliExpress shows any currency; eBay, Walmart and Etsy show the currency of their site, and rows in another currency are left out of the cross-marketplace cheapest offer."
},
"condition": {
"title": "Condition",
"enum": [
"any",
"new",
"used"
],
"type": "string",
"description": "New or used items. Applied by eBay's search filter and to Walmart's labelled pre-owned items. AliExpress and Etsy do not show a condition: kept for new, skipped for used. Default any: every product, and no marketplace left out.",
"default": "any"
},
"priceMin": {
"title": "Min price",
"minimum": 0,
"maximum": 1000000000,
"type": "number",
"description": "Keep only products priced at least this amount, in the currency of the results, e.g. 15 or 9.99. Sent to the marketplace's own filter where it has one, then checked on every product returned. Leave empty for no minimum."
},
"priceMax": {
"title": "Max price",
"minimum": 0,
"maximum": 1000000000,
"type": "number",
"description": "Keep only products priced at most this amount, in the currency of the results, e.g. 50; it must be at least priceMin. Sent to the marketplace's own filter where it has one, then checked on every product returned. Leave empty for no maximum."
},
"proxyConfiguration": {
"title": "Proxy configuration",
"type": "object",
"description": "Keep the default (Apify Proxy, no group): each marketplace then uses the proxy validated for it, included in the price. A proxy group or your own proxy URLs set here apply to every marketplace.",
"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
}
}
}
}
}
}
}
}
}
}