{ "openapi": "3.0.1", "info": { "title": "eBay Reviews & Seller Feedback Scraper", "description": "Scrape eBay product reviews by product, item or EPID and seller feedback by username, store or item. Star rating, positive/neutral/negative, period and keyword filters. 17 eBay marketplaces.", "version": "0.1", "x-build-id": "mg0OYjq1GmgGrG5MX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/epicscrapers~ebay-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-epicscrapers-ebay-reviews-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/epicscrapers~ebay-reviews-scraper/runs": { "post": { "operationId": "runs-sync-epicscrapers-ebay-reviews-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/epicscrapers~ebay-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-epicscrapers-ebay-reviews-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": [ "startUrls" ], "properties": { "startUrls": { "title": "eBay URLs, IDs or usernames", "type": "array", "description": "What to scrape, one per line. Product reviews: product URLs (`ebay.com/p/4062765295`), product review URLs (`/urw/.../product-reviews/...`), item URLs (`ebay.com/itm/...`) or IDs (a 12-digit number is an item ID, any other number an EPID; force it with `epid:` or `item:`). Seller feedback: usernames, profile URLs (`/usr/name`), feedback profile URLs (`/fdbk/feedback_profile/name`), store URLs (`/str/name`) or item URLs. The site of a URL wins over the Marketplace setting.", "items": { "type": "string" } }, "mode": { "title": "What to scrape", "enum": [ "auto", "productReviews", "sellerFeedback", "both" ], "type": "string", "description": "Auto: products give product reviews, sellers and stores give seller feedback, items give product reviews when the item belongs to an eBay catalog product and the seller's feedback otherwise. The other modes force one type for items, or both.", "default": "auto" }, "site": { "title": "Marketplace", "enum": [ "ebay.com", "ebay.co.uk", "ebay.de", "ebay.fr", "ebay.it", "ebay.es", "ebay.ca", "ebay.com.au", "ebay.nl", "ebay.at", "ebay.ch", "ebay.ie", "ebay.pl", "ebay.com.hk", "ebay.com.my", "ebay.ph", "ebay.com.sg" ], "type": "string", "description": "eBay site for plain IDs and usernames. Product reviews depend on the site (eBay shows the reviews written on that marketplace, sometimes with reviews from related sites mixed in). Seller feedback is the same everywhere, but labels, item links and prices follow the site.", "default": "ebay.com" }, "maxItemsPerSource": { "title": "Max items per source", "minimum": 0, "type": "integer", "description": "Most reviews or feedback entries to save per input line and type. 0 means no limit.", "default": 100 }, "maxItems": { "title": "Max items in total", "minimum": 0, "type": "integer", "description": "Stop the run after this many saved items across all sources. 0 means no limit.", "default": 0 }, "reviewSort": { "title": "Sort product reviews by", "enum": [ "relevance", "newest", "oldest", "highestRating", "lowestRating", "mostHelpful" ], "type": "string", "description": "Order in which eBay returns product reviews.", "default": "relevance" }, "reviewStarRatings": { "title": "Star ratings", "type": "array", "description": "Keep only reviews with these star ratings. Empty keeps all. eBay has no rating filter for reviews, so the Actor reads all reviews and filters them; sort by highest or lowest rating to stop early.", "items": { "type": "string", "enum": [ "5", "4", "3", "2", "1" ], "enumTitles": [ "5 stars", "4 stars", "3 stars", "2 stars", "1 star" ] }, "default": [] }, "verifiedPurchasesOnly": { "title": "Verified purchases only", "type": "boolean", "description": "Keep only reviews eBay marks as verified purchases.", "default": false }, "reviewKeyword": { "title": "Review keyword", "type": "string", "description": "Keep only reviews that mention this word or phrase (eBay's own review search).", "default": "" }, "feedbackRole": { "title": "Feedback type", "enum": [ "receivedAsSeller", "receivedAsBuyer", "allReceived", "leftForOthers" ], "type": "string", "description": "Which feedback of the member to scrape: received as a seller (from buyers), received as a buyer (from sellers), both, or the feedback the member left for others. Feedback from sellers names the seller unmasked and has no item details on eBay.", "default": "receivedAsSeller" }, "feedbackRatings": { "title": "Feedback ratings", "type": "array", "description": "Keep only positive, neutral or negative feedback. Empty keeps all. Combined with a period, eBay filters on its side (fast); with the period \"All time\" the Actor reads all feedback and filters it.", "items": { "type": "string", "enum": [ "positive", "neutral", "negative" ], "enumTitles": [ "Positive", "Neutral", "Negative" ] }, "default": [] }, "feedbackPeriod": { "title": "Feedback period", "enum": [ "all", "1m", "6m", "12m" ], "type": "string", "description": "Only feedback left within this period.", "default": "all" }, "feedbackSort": { "title": "Sort feedback by", "enum": [ "newest", "relevance" ], "type": "string", "description": "Order in which eBay returns feedback.", "default": "newest" }, "includeAutomatedFeedback": { "title": "Include eBay automated feedback", "type": "boolean", "description": "eBay leaves automated positive feedback (\"Order delivered on time with no issues\") when a buyer leaves none. Off by default because it carries no buyer text.", "default": false }, "feedbackWithPhotosOnly": { "title": "Feedback with photos only", "type": "boolean", "description": "Keep only feedback where the buyer added photos.", "default": false }, "feedbackKeyword": { "title": "Feedback keyword or item ID", "type": "string", "description": "eBay's feedback search: an item title word or an item ID. eBay searches the last 5 years and cannot combine this with a period or rating filter (ratings are then filtered by the Actor; the period is ignored).", "default": "" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Residential proxy in the marketplace's country is recommended. Without a proxy eBay may block the run.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }