{ "openapi": "3.0.1", "info": { "title": "eBay Search Results Scraper - Prices & Sold Data", "description": "Turn eBay searches into clean JSON: total price (item + shipping), condition, seller ratings, sold counts, images, search rank. Active or sold & completed listings across 8 marketplaces. Fast, no browser - built for price monitoring, repricing, and market research.", "version": "0.1", "x-build-id": "jOKREgYugkC1hVlS2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/valev-lab~ebay-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-valev-lab-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/valev-lab~ebay-search-scraper/runs": { "post": { "operationId": "runs-sync-valev-lab-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/valev-lab~ebay-search-scraper/run-sync": { "post": { "operationId": "run-sync-valev-lab-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": { "searchQueries": { "title": "Search queries", "type": "array", "description": "Keywords to search on eBay. Each entry runs its own search. Required unless you provide Start URLs below.", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Direct eBay search-results URLs to scrape (e.g. category pages, or sold listings with LH_Sold=1&LH_Complete=1). The Actor keeps all your parameters, forces 60 items per page, and paginates. Use this OR Search queries (you can use both).", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "marketplace": { "title": "Marketplace", "enum": [ "ebay.com", "ebay.co.uk", "ebay.de", "ebay.fr", "ebay.it", "ebay.es", "ebay.com.au", "ebay.ca" ], "type": "string", "description": "Which eBay marketplace (domain) to search. Only used when building URLs from Search queries; Start URLs keep their own domain. Currency is read per listing.", "default": "ebay.com" }, "maxProductsPerSearch": { "title": "Max products per search", "minimum": 0, "type": "integer", "description": "Maximum number of listings to collect per search query / Start URL. Use 0 for no cap.", "default": 100 }, "maxSearchPages": { "title": "Max search pages", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum result pages to open per search (60 listings per page). eBay itself caps search results at around 20 pages.", "default": 5 }, "sort": { "title": "Sort by", "enum": [ "best_match", "ending_soonest", "newly_listed", "price_low", "price_high" ], "type": "string", "description": "How eBay should sort the results.", "default": "best_match" }, "condition": { "title": "Item condition", "type": "array", "description": "Restrict to one or more item conditions. Leave empty for all conditions.", "items": { "type": "string", "enum": [ "new", "open_box", "certified_refurbished", "seller_refurbished", "used", "for_parts" ], "enumTitles": [ "New", "Open box", "Certified refurbished", "Seller refurbished", "Used", "For parts / not working" ] }, "default": [] }, "listingType": { "title": "Listing type", "enum": [ "all", "auction", "buy_it_now", "best_offer" ], "type": "string", "description": "Restrict to a buying format.", "default": "all" }, "listingStatus": { "title": "Listing status", "enum": [ "active", "sold" ], "type": "string", "description": "Active listings (default), or sold & completed listings — real sale prices for market analysis.", "default": "active" }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "number", "description": "Lowest price to include, in the marketplace currency. Leave empty for no minimum." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "number", "description": "Highest price to include, in the marketplace currency. Leave empty for no maximum." }, "freeShippingOnly": { "title": "Free shipping only", "type": "boolean", "description": "Only include listings that offer free shipping (eBay LH_FS filter).", "default": false }, "sellerLocation": { "title": "Seller / item location", "enum": [ "all", "domestic_only", "worldwide" ], "type": "string", "description": "Restrict by where the item is located.", "default": "all" }, "deduplicateItems": { "title": "Deduplicate items", "type": "boolean", "description": "Skip listings whose eBay item ID was already scraped earlier in this run (across queries and pages).", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. Residential proxies are strongly recommended — eBay blocks datacenter IPs. The proxy country is auto-set to match the marketplace (e.g. ebay.de → Germany) so prices and shipping are market-native; pick a Country here to override.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "maxRequestRetries": { "title": "Max request retries", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many times a failed/blocked page request is retried (each retry uses a fresh session).", "default": 5 }, "debugLog": { "title": "Debug logging", "type": "boolean", "description": "Enable verbose logging, and dump the first fetched page's raw HTML to the key-value store (key DEBUG_PAGE_HTML) so you can capture a real fixture.", "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 } } } } } } } } } }