{ "openapi": "3.0.1", "info": { "title": "eBay Listings Scraper", "description": "Extract active eBay listings by keyword or URL across eBay country sites: titles, prices, conditions, sold counts, seller feedback, item specifics and images, with price, condition and format filters.", "version": "0.0", "x-build-id": "pq4wH3w6M6liJh4nJ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/piotrv1001~ebay-listings-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-piotrv1001-ebay-listings-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/piotrv1001~ebay-listings-scraper/runs": { "post": { "operationId": "runs-sync-piotrv1001-ebay-listings-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/piotrv1001~ebay-listings-scraper/run-sync": { "post": { "operationId": "run-sync-piotrv1001-ebay-listings-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": "Keywords to search on eBay, one search each, e.g. iphone 15 or nike air max 90. Leave empty if you only use Start URLs.", "items": { "type": "string" } }, "marketplace": { "title": "eBay site", "enum": [ "ebay.com", "ebay.co.uk", "ebay.de", "ebay.fr", "ebay.it", "ebay.es", "ebay.ca", "ebay.com.au", "ebay.at", "ebay.ch", "ebay.nl", "ebay.ie", "ebay.pl" ], "type": "string", "description": "The eBay country site keyword searches run on. Start URLs always stay on their own site.", "default": "ebay.com" }, "startUrls": { "title": "Start URLs", "type": "array", "description": "eBay search, category, seller, store or individual item URLs. Paste any results page from your browser, e.g. https://www.ebay.com/sch/i.html?_nkw=iphone+15 or https://www.ebay.com/b/Cell-Phones-Smartphones/9355/bn_320094, and the scraper paginates through it. Seller pages (ebay.com/usr/name) and stores (ebay.com/str/name) return that seller's listings. Item URLs such as https://www.ebay.com/itm/335889480295 are fetched as full detail records regardless of the details toggle. Sold/completed results are not supported: eBay shows them only to signed-in users, so such URLs are skipped.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max items", "minimum": 0, "type": "integer", "description": "Maximum number of listings to scrape across all keywords and start URLs. Set to 0 for no limit. Searches bigger than eBay's ~10,000-result limit are split by price automatically; each listing is returned and charged once.", "default": 50 }, "scrapeDetails": { "title": "Scrape listing details", "type": "boolean", "description": "When enabled, each listing's detail page is visited to extract richer data: full item specifics, seller profile and feedback, seller notes, and the complete image gallery. Slower and more expensive than the listing-only mode.", "default": false }, "minPrice": { "title": "Min price", "minimum": 0, "type": "number", "description": "Lowest price, in the currency of the eBay site." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "number", "description": "Highest price, in the currency of the eBay site." }, "condition": { "title": "Condition", "enum": [ "new", "open_box", "refurbished", "used", "for_parts" ], "type": "string", "description": "Only listings in this condition." }, "buyingFormat": { "title": "Buying format", "enum": [ "auction", "buy_it_now", "best_offer" ], "type": "string", "description": "Only listings sold this way." }, "sort": { "title": "Sort by", "enum": [ "best_match", "ending_soonest", "newly_listed", "price_lowest", "price_highest" ], "type": "string", "description": "The order of results. Without it, eBay's Best Match, or the sort already in your URL." }, "category": { "title": "Category ID", "type": "string", "description": "eBay category number, the number in a category URL, e.g. 9355 for Cell Phones & Smartphones." }, "seller": { "title": "Seller", "type": "string", "description": "Only this seller's listings: their eBay username." }, "freeShipping": { "title": "Free shipping only", "type": "boolean", "description": "Only listings with free shipping." }, "itemLocation": { "title": "Item location", "enum": [ "domestic", "worldwide" ], "type": "string", "description": "Where the item ships from, relative to the eBay site." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings used for requests. US residential proxies are required for this target and are enabled by default.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }