{ "openapi": "3.0.1", "info": { "title": "eBay Search Scraper - Listings, Prices & Sellers", "description": "Scrape eBay search results in bulk - get product titles, prices, condition, shipping, sellers, watchers and image URLs as clean JSON. No eBay API key needed. Pass many keywords or eBay search URLs per run, paginate deep, on any eBay marketplace.", "version": "0.1", "x-build-id": "ggpFgZIE1sMy8kiqf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapeworks~ebay-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapeworks-ebay-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/scrapeworks~ebay-search-scraper/runs": { "post": { "operationId": "runs-sync-scrapeworks-ebay-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/scrapeworks~ebay-search-scraper/run-sync": { "post": { "operationId": "run-sync-scrapeworks-ebay-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", "properties": { "searchTerms": { "title": "Search keywords", "uniqueItems": true, "type": "array", "description": "One or more keywords/phrases to search on eBay (e.g. 'mechanical keyboard', 'vintage rolex'). Each term is searched separately and paginated deep up to 'Max results per query'. Add as many as you like in a single run.", "items": { "type": "string" } }, "directUrls": { "title": "eBay search URLs (optional, power users)", "uniqueItems": true, "type": "array", "description": "Optional: paste full eBay search-results URLs (e.g. an /sch/i.html?... link with your own filters, category or price range already applied). Each URL is scraped and paginated just like a keyword. Use this when you want eBay's own advanced filters; otherwise just use 'Search keywords'.", "items": { "type": "string" } }, "domain": { "title": "eBay marketplace", "enum": [ "ebay.com", "ebay.co.uk", "ebay.de", "ebay.com.au", "ebay.ca", "ebay.fr", "ebay.it", "ebay.es", "ebay.nl", "ebay.ie", "ebay.in" ], "type": "string", "description": "Which eBay site to search. Prices are returned in that site's local currency. Most-used is ebay.com (US).", "default": "ebay.com" }, "maxResultsPerQuery": { "title": "Max results per query", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum listings to return for EACH keyword/URL. The actor paginates automatically (240 listings per page). eBay itself caps a single search at a few thousand results.", "default": 100 }, "sortBy": { "title": "Sort by", "enum": [ "best_match", "ending_soonest", "newly_listed", "price_low", "price_high" ], "type": "string", "description": "Result order, same as eBay's own sort dropdown.", "default": "best_match" }, "conditionFilter": { "title": "Item condition", "enum": [ "any", "new", "used", "open_box", "refurbished" ], "type": "string", "description": "Only return listings of this condition. 'Any' returns everything.", "default": "any" }, "buyingFormat": { "title": "Buying format", "enum": [ "any", "buy_it_now", "auction" ], "type": "string", "description": "Restrict to a buying format. 'Any' returns both fixed-price and auction listings.", "default": "any" }, "freeShippingOnly": { "title": "Free shipping only", "type": "boolean", "description": "If on, only return listings that offer free shipping.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy used to reach eBay. eBay blocks datacenter traffic, so RESIDENTIAL Apify Proxy is strongly recommended for reliable results. Defaults to Apify Proxy.", "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 } } }, "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 } } } } } } } } } }