{ "openapi": "3.0.1", "info": { "title": "eBay Real-Time Data Scraper — Search, Listings, Sellers & Deals", "description": "Real-time eBay scraper for search, listing details, seller feedback, store profiles, catalog products, deals & category browse. 20 marketplaces, 8 checkbox features, CAPTCHA-ready, residential proxy support. Clean JSON—perfect for sellers, researchers & API workflows.", "version": "0.0", "x-build-id": "nmU6Sdc1SK84IYfIF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/b2b_leads~eBay-Real-Time-Data/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-b2b_leads-eBay-Real-Time-Data", "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/b2b_leads~eBay-Real-Time-Data/runs": { "post": { "operationId": "runs-sync-b2b_leads-eBay-Real-Time-Data", "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/b2b_leads~eBay-Real-Time-Data/run-sync": { "post": { "operationId": "run-sync-b2b_leads-eBay-Real-Time-Data", "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": { "country": { "title": "Marketplace country", "enum": [ "US", "UK", "DE", "FR", "IT", "ES", "AU", "CA", "AT", "CH", "IE", "NL", "BE", "PL", "SG", "MY", "PH", "HK", "MX", "BR" ], "type": "string", "description": "eBay marketplace to scrape. Drives domain, currency, and language headers.", "default": "US" }, "enableProductSearch": { "title": "Product Search", "type": "boolean", "description": "Search eBay by keyword and return matching listings from search results.", "default": true }, "searchKeywords": { "title": "Search keywords", "type": "array", "description": "One or more keywords to search (1–20). Required when Product Search is enabled.", "default": [ "wireless mouse" ], "items": { "type": "string" } }, "searchMaxResultsPerKeyword": { "title": "Max results per keyword", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum listings to return per keyword (1–100).", "default": 10 }, "searchPage": { "title": "Start page", "minimum": 1, "maximum": 20, "type": "integer", "description": "First search results page to scrape (1-based).", "default": 1 }, "searchMaxPages": { "title": "Max pages per keyword", "minimum": 1, "maximum": 10, "type": "integer", "description": "Number of search result pages to crawl per keyword.", "default": 1 }, "searchSort": { "title": "Sort order", "enum": [ "best-match", "price-asc", "price-desc", "ending-soonest", "newly-listed", "distance" ], "type": "string", "description": "How to sort search results on eBay.", "default": "best-match" }, "searchCategoryId": { "title": "Category ID (optional)", "type": "string", "description": "Restrict search to an eBay category using its numeric category ID.", "default": "" }, "searchCondition": { "title": "Item condition", "enum": [ "all", "new", "used", "not-specified", "for-parts" ], "type": "string", "description": "Filter search results by item condition.", "default": "all" }, "searchBuyingFormat": { "title": "Buying format", "enum": [ "all", "auction", "buy-it-now", "best-offer", "classified" ], "type": "string", "description": "Filter by listing format.", "default": "all" }, "searchShowOnly": { "title": "Show only", "type": "array", "description": "Additional eBay search filters. Allowed values per entry: free-shipping, returns-accepted, authorized-seller, deals, completed, sold.", "default": [], "items": { "type": "string" } }, "enableProductDetails": { "title": "Product Details", "type": "boolean", "description": "Fetch full listing page data for specific item IDs or URLs.", "default": false }, "itemIds": { "title": "Item IDs", "type": "array", "description": "Numeric eBay item IDs to scrape (e.g. 123456789012).", "default": [], "items": { "type": "string" } }, "productUrls": { "title": "Listing URLs", "type": "array", "description": "Alternative to item IDs — paste full eBay listing URLs.", "default": [], "items": { "type": "string" } }, "includeDescription": { "title": "Include description", "type": "boolean", "description": "Include listing description text in output.", "default": true }, "includeImages": { "title": "Include images", "type": "boolean", "description": "Include listing image URLs in output.", "default": true }, "enableSellerFeedback": { "title": "Seller Feedback", "type": "boolean", "description": "Scrape seller feedback ratings and recent comments for given usernames.", "default": false }, "sellerUsernames": { "title": "Seller usernames", "type": "array", "description": "eBay seller usernames for Seller Feedback and/or Seller Profile features.", "default": [], "items": { "type": "string" } }, "feedbackMaxPerSeller": { "title": "Max feedback entries per seller", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum feedback comments to collect per seller (1–100).", "default": 10 }, "feedbackPeriod": { "title": "Feedback period", "enum": [ "all", "1-month", "6-months", "12-months" ], "type": "string", "description": "Time window for feedback entries.", "default": "all" }, "feedbackPage": { "title": "Feedback start page", "minimum": 1, "maximum": 20, "type": "integer", "description": "First feedback page to scrape (1-based).", "default": 1 }, "feedbackMaxPages": { "title": "Max feedback pages per seller", "minimum": 1, "maximum": 20, "type": "integer", "description": "Number of feedback pages to crawl per seller.", "default": 5 }, "feedbackProductId": { "title": "Filter by item ID (optional)", "type": "string", "description": "Only collect feedback related to this eBay item ID.", "default": "" }, "feedbackFilterRating": { "title": "Feedback rating filter", "enum": [ "all", "positive", "neutral", "negative" ], "type": "string", "description": "Filter feedback by rating type.", "default": "all" }, "enableSellerProfile": { "title": "Seller Profile", "type": "boolean", "description": "Scrape seller store pages: feedback score, member since, location, store info, and optional active listings.", "default": false }, "includeSellerProducts": { "title": "Include seller products", "type": "boolean", "description": "When Seller Profile is enabled, also scrape the seller's active listings as seller_products rows.", "default": true }, "sellerProductsMaxResults": { "title": "Max seller products", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum active listing rows to return per seller when includeSellerProducts is true (1–100).", "default": 20 }, "enableCatalogProduct": { "title": "Catalog Product Details", "type": "boolean", "description": "Scrape eBay catalog/ePID product pages: specs, aggregate ratings, price range, and listing count.", "default": false }, "catalogEpids": { "title": "Catalog ePIDs", "type": "array", "description": "Numeric eBay product catalog IDs (ePID) to scrape, e.g. 123456789.", "default": [], "items": { "type": "string" } }, "catalogUrls": { "title": "Catalog URLs", "type": "array", "description": "Full eBay catalog page URLs (alternative to catalogEpids).", "default": [], "items": { "type": "string" } }, "enableScrapeByUrl": { "title": "Scrape By URL", "type": "boolean", "description": "Scrape arbitrary eBay URLs with auto page-type detection.", "default": false }, "scrapeUrls": { "title": "eBay URLs", "type": "array", "description": "eBay URLs to scrape.", "default": [], "items": { "type": "string" } }, "scrapeExtractType": { "title": "Extract type", "enum": [ "auto", "listing", "search", "deals", "category", "seller", "feedback" ], "type": "string", "description": "Force a page type instead of auto-detection.", "default": "auto" }, "scrapeMaxPages": { "title": "Max pages per URL", "minimum": 1, "maximum": 10, "type": "integer", "description": "Pages to crawl for paginated list/feedback URLs.", "default": 1 }, "enableCategoryBrowse": { "title": "Category Browse", "type": "boolean", "description": "Browse eBay category pages and collect listings.", "default": false }, "categoryIds": { "title": "Category IDs", "type": "array", "description": "Numeric eBay category IDs to browse.", "default": [], "items": { "type": "string" } }, "categoryUrls": { "title": "Category URLs", "type": "array", "description": "Full eBay category page URLs (alternative to category IDs).", "default": [], "items": { "type": "string" } }, "categoryMaxProducts": { "title": "Max products per category", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum listings to return per category (1–100).", "default": 50 }, "categoryQuery": { "title": "Category search query (optional)", "type": "string", "description": "Optional keyword to narrow listings within the category.", "default": "" }, "categoryPage": { "title": "Category start page", "minimum": 1, "maximum": 20, "type": "integer", "description": "First category results page (1-based).", "default": 1 }, "categoryMaxPages": { "title": "Max pages per category", "minimum": 1, "maximum": 10, "type": "integer", "description": "Number of result pages to crawl per category.", "default": 5 }, "enableDeals": { "title": "Deals", "type": "boolean", "description": "Scrape eBay Deals hub pages.", "default": false }, "dealsMaxProducts": { "title": "Max deals", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of deals to return (1–100).", "default": 50 }, "dealsCategoryId": { "title": "Deals category ID (optional)", "type": "string", "description": "Filter deals by eBay category ID.", "default": "" }, "dealsMinDiscountPercent": { "title": "Minimum discount (%)", "minimum": 0, "type": "number", "description": "Only include deals with at least this discount percentage.", "default": 0 }, "dealsOffset": { "title": "Deals offset", "minimum": 0, "type": "integer", "description": "Starting offset for paginated deals pages.", "default": 0 }, "proxyConfiguration": { "title": "Proxy settings", "type": "object", "description": "Use Apify Proxy with US Residential for best results on eBay. Leave the default unless you know you need something else.", "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 } } }, "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 } } } } } } } } } }