{ "openapi": "3.0.1", "info": { "title": "eBay Product Scraper", "description": "Fast, reliable eBay scraper. Extract product search results, pricing, shipping, seller specs, item condition & high-res images to JSON/Excel. No API key needed.", "version": "2.0", "x-build-id": "uyv5YQDqWz4wM3wpn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/incognito_mode~ebay-product-scrapper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-incognito_mode-ebay-product-scrapper", "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/incognito_mode~ebay-product-scrapper/runs": { "post": { "operationId": "runs-sync-incognito_mode-ebay-product-scrapper", "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/incognito_mode~ebay-product-scrapper/run-sync": { "post": { "operationId": "run-sync-incognito_mode-ebay-product-scrapper", "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": { "search": { "title": "Search keywords", "type": "array", "description": "One or more keywords to search on eBay, e.g. `macbook pro m3`. Each keyword is crawled separately. Provide this or Start URLs (or both).", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs", "type": "array", "description": "eBay search-results URLs or individual listing (`/itm/...`) URLs. Listing URLs are scraped directly; search URLs are paginated. Non-eBay URLs are ignored.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL", "description": "eBay URL" } } } }, "ebaySite": { "title": "eBay marketplace", "enum": [ "ebay.com", "ebay.co.uk", "ebay.de", "ebay.ca", "ebay.com.au", "ebay.fr", "ebay.it", "ebay.es", "ebay.nl", "ebay.ie", "ebay.at", "ebay.ch", "ebay.be", "ebay.pl", "ebay.com.sg", "ebay.com.my", "ebay.ph", "ebay.com.hk" ], "type": "string", "description": "Regional eBay site used for keyword searches. Ignored for Start URLs, which keep their own domain.", "default": "ebay.com" }, "maxItems": { "title": "Maximum items", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Hard cap on how many products are stored in the dataset. The run stops as soon as it is reached.", "default": 2 }, "maxPagesPerQuery": { "title": "Maximum search pages per query", "minimum": 1, "maximum": 200, "type": "integer", "description": "How deep to paginate each search. eBay serves up to 240 listings per page, so 5 pages is already ~1200 listings.", "default": 5 }, "scrapeDetails": { "title": "Open each listing page", "type": "boolean", "description": "Visit every listing to collect item specifics, the full image gallery, return policy, availability and description. Turn this off for a much faster and cheaper run — the search page alone already yields price, shipping, condition, seller rating, location and watch counts.", "default": true }, "scrapeDescription": { "title": "Include the seller's description", "type": "boolean", "description": "Fetch the description iframe for each listing (one extra request per item). Requires \"Open each listing page\".", "default": true }, "includeDescriptionHtml": { "title": "Also keep the description as raw HTML", "type": "boolean", "description": "Store `descriptionHtml` alongside `descriptionText`. Descriptions can be large, so leaving this off keeps the dataset small.", "default": false }, "sortBy": { "title": "Sort results by", "enum": [ "bestMatch", "lowestPrice", "highestPrice", "newlyListed", "endingSoonest" ], "type": "string", "description": "Sort order applied to keyword searches.", "default": "bestMatch" }, "itemCondition": { "title": "Item condition", "enum": [ "all", "new", "refurbished", "used" ], "type": "string", "description": "Filter keyword searches by condition.", "default": "all" }, "listingType": { "title": "Listing type", "enum": [ "all", "buyItNow", "auction" ], "type": "string", "description": "Filter keyword searches by purchase format.", "default": "all" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "eBay blocks datacenter traffic aggressively. Residential proxies are strongly recommended — without them most runs will be challenged.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "crawlerMode": { "title": "Crawler mode", "enum": [ "auto", "http", "browser" ], "type": "string", "description": "`Automatic` sends one probe request and picks the cheapest transport that eBay accepts for this run, falling back to a browser for anything that gets blocked. Force `HTTP only` for maximum speed or `Browser` if you are seeing persistent challenges.", "default": "auto" }, "maxConcurrency": { "title": "Maximum concurrency", "minimum": 1, "maximum": 50, "type": "integer", "description": "Upper bound on parallel requests. Lower it if eBay starts challenging the run; the Actor also scales down automatically when memory is tight.", "default": 10 }, "maxRequestRetries": { "title": "Maximum retries per request", "minimum": 0, "maximum": 20, "type": "integer", "description": "How many times a blocked or failed request is retried (each retry uses a fresh proxy IP and browser fingerprint).", "default": 5 }, "debugSnapshots": { "title": "Save HTML snapshots on parse failures", "type": "boolean", "description": "When a page loads but nothing can be extracted, store its HTML in the key-value store for debugging. Useful when reporting that eBay changed its markup.", "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 } } }, "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 } } } } } } } } } }