{ "openapi": "3.0.1", "info": { "title": "eBay Scraper — Active, Sold & Seller Listings", "description": "Scrape eBay listings by keyword, URL or seller. Extract active and sold items with prices, shipping, item specifics, variants, and full descriptions across 13 global marketplaces. Built-in sold price analytics.", "version": "1.0", "x-build-id": "vNx598GtgcCw9aldg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/brilliant_gum~ebay-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-brilliant_gum-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/brilliant_gum~ebay-scraper/runs": { "post": { "operationId": "runs-sync-brilliant_gum-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/brilliant_gum~ebay-scraper/run-sync": { "post": { "operationId": "run-sync-brilliant_gum-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": { "startUrls": { "title": "Start URLs", "type": "array", "description": "eBay search result pages, item pages, or seller store URLs to scrape directly.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "searchKeywords": { "title": "Search Keywords", "type": "array", "description": "Keywords to search on eBay (e.g. [\"iPhone 15 Pro\", \"vintage Lego\"]). Each keyword is searched independently.", "items": { "type": "string" } }, "sellerUsername": { "title": "Seller Username", "type": "string", "description": "Scrape all listings from a specific eBay seller (e.g. \"great_deals_store\"). Leave empty to skip." }, "ebayDomain": { "title": "eBay Marketplace", "enum": [ "US", "UK", "DE", "FR", "IT", "ES", "AU", "CA", "NL", "AT", "CH", "IE", "PL" ], "type": "string", "description": "Which eBay marketplace to scrape.", "default": "US" }, "activeListings": { "title": "Scrape active listings", "type": "boolean", "description": "Include current active listings (items for sale now).", "default": true }, "soldListings": { "title": "Scrape sold listings", "type": "boolean", "description": "Include recently sold listings. Useful for price research and market analysis. eBay shows sold data from the last 90 days.", "default": false }, "listingType": { "title": "Listing type", "enum": [ "All", "BuyItNow", "Auction" ], "type": "string", "description": "Filter by listing type.", "default": "All" }, "condition": { "title": "Condition", "enum": [ "All", "New", "Used", "Refurbished" ], "type": "string", "description": "Filter by item condition.", "default": "All" }, "minPrice": { "title": "Min price", "minimum": 0, "type": "number", "description": "Minimum price filter (in the marketplace currency). 0 = no minimum.", "default": 0 }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "number", "description": "Maximum price filter. 0 = no maximum.", "default": 0 }, "maxResults": { "title": "Max results per source", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of listings to return per keyword, seller, or URL. eBay caps search results at 10,000 items.", "default": 50 }, "sortBy": { "title": "Sort by", "enum": [ "BestMatch", "PriceAsc", "PriceDesc", "NewlyListed", "EndingSoon" ], "type": "string", "description": "How to sort search results.", "default": "BestMatch" }, "visitItemPage": { "title": "Visit item pages", "type": "boolean", "description": "Visit each item's page to extract full details: item specifics, description, all images, variants/MSKU, watch count, exact shipping. Slower but more complete data.", "default": false }, "includeAnalytics": { "title": "Include analytics report", "type": "boolean", "description": "Generate a comprehensive price analytics report (avg/median prices, sell-through rate, condition/category breakdown) saved to Key-Value store as ANALYTICS.", "default": true }, "requestDelayMs": { "title": "Request delay (ms)", "minimum": 0, "type": "integer", "description": "Milliseconds to wait between requests. Increase to 3000+ for large runs to avoid rate limiting.", "default": 2000 } } }, "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 } } } } } } } } } }