{ "openapi": "3.0.1", "info": { "title": "eBay Scraper — Listings, Prices & Sellers", "description": "Scrape eBay search results on ebay.com, ebay.co.uk, ebay.de and more: price, shipping, condition, auction bids and time left, sold count, seller feedback; optional item specifics.", "version": "0.1", "x-build-id": "G68Wuqm4Np1uHPrlS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tortuga~ebay-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tortuga-ebay-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/tortuga~ebay-scraper/runs": { "post": { "operationId": "runs-sync-tortuga-ebay-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/tortuga~ebay-scraper/run-sync": { "post": { "operationId": "run-sync-tortuga-ebay-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 terms", "type": "array", "description": "Keywords to search on eBay, one per line (e.g. \"nintendo switch\", \"rolex submariner\"). Each term is searched separately on the chosen marketplace and paginated automatically (240 listings per page).", "items": { "type": "string" } }, "marketplace": { "title": "Marketplace", "enum": [ "com", "co.uk", "de", "com.au", "at", "ie" ], "type": "string", "description": "eBay site to search for the search terms. Prices come in the site's currency. Start URLs always use the site in the URL.", "default": "com" }, "startUrls": { "title": "Start URLs", "type": "array", "description": "eBay URLs to scrape instead of (or in addition to) search terms: search result pages with any filters you set on eBay (https://www.ebay.com/sch/i.html?_nkw=lego&LH_BIN=1) or single item pages (https://www.ebay.com/itm/134353979702, returned with full details). Sold / completed searches (LH_Sold=1) need an eBay login since July 2026 and are skipped.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Stop after this many listings in total (across all search terms and URLs). Keeps cost predictable.", "default": 100 }, "maxPagesPerSearch": { "title": "Max pages per search", "minimum": 1, "maximum": 42, "type": "integer", "description": "How many result pages to open per search term or search URL (240 listings each). eBay shows at most about 10,000 listings per search (42 pages); split big searches by category or price range to go deeper.", "default": 10 }, "includeDetails": { "title": "Include item details", "type": "boolean", "description": "Also open every listing's item page for item specifics (brand, model, MPN, EAN/UPC and all other attributes), exact seller feedback score, quantity available and sold, watch count, start and end date, item location city, shipping service and delivery estimate, return policy, category path and all images. Slower and charged extra per listing (see pricing). eBay checks item pages harder than search pages: use RESIDENTIAL proxies for large detail runs (~98% first-try success vs ~50% on datacenter).", "default": false }, "sort": { "title": "Sort by", "enum": [ "best_match", "ending_soonest", "newly_listed", "price_low", "price_high", "distance" ], "type": "string", "description": "Result order for search terms (start URLs keep their own sort).", "default": "best_match" }, "listingType": { "title": "Buying format", "enum": [ "all", "auction", "buy_it_now", "best_offer" ], "type": "string", "description": "Only auctions, only Buy It Now listings, or only listings that accept offers (search terms only).", "default": "all" }, "condition": { "title": "Condition", "enum": [ "any", "new", "used", "refurbished", "for_parts" ], "type": "string", "description": "Item condition filter (search terms only).", "default": "any" }, "minPrice": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Lowest item price in the marketplace currency (search terms only). Leave empty for no limit." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Highest item price in the marketplace currency (search terms only). Leave empty for no limit." }, "categoryId": { "title": "Category ID", "type": "string", "description": "Optional eBay category ID to search in (the number in eBay category URLs, e.g. 139971 for Video Game Consoles on ebay.com). Search terms only." }, "includePartialMatches": { "title": "Include partial matches", "type": "boolean", "description": "When eBay finds no exact matches for a search it shows loosely related listings instead (\"No exact matches found\"). By default those are skipped; turn this on to save them too (flagged with partialMatch: true).", "default": false }, "onlyNewOrChanged": { "title": "Only new or changed items", "type": "boolean", "description": "Remember what earlier runs of this search returned and output only new items or items whose price/status changed. Use with a Schedule; unchanged items are not charged. With this on, Max items is the number of listings checked each run (the watched window, e.g. the newest 100), so a run never digs deeper than the first one. Price, the struck-through original price and the stock hint (\"Last one\") are compared; shipping is not (eBay calculates it per visitor location).", "default": false }, "monitoringKey": { "title": "Monitoring key", "type": "string", "description": "Name for this watch, so several schedules on the same search stay separate; defaults to a key derived from the search input." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy. Datacenter (the default) works well for search pages: the actor rotates browser fingerprints and IPs when eBay shows its 'Pardon our interruption' check. For item details, RESIDENTIAL proxies get through far more often (they cost per GB of traffic, about 170 KB per item page, roughly $1.40 per 1,000 item pages at $8/GB). No Unblocker charges.", "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 } } } } } } } } } }