{ "openapi": "3.0.1", "info": { "title": "eBay Product Scraper - Prices, Ratings & Listings", "description": "Scrape eBay product listings in one run. Get titles, prices, conditions, ratings, images, and shipping details for marketplace pricing and product research.", "version": "0.10", "x-build-id": "tYOP12jL1CqWqT0uR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lentic_clockss~ecommerce-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lentic_clockss-ecommerce-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/lentic_clockss~ecommerce-scraper/runs": { "post": { "operationId": "runs-sync-lentic_clockss-ecommerce-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/lentic_clockss~ecommerce-scraper/run-sync": { "post": { "operationId": "run-sync-lentic_clockss-ecommerce-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", "required": [ "keyword" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "seller" ], "type": "string", "description": "search = keyword search (default). seller = collect a seller's full live inventory via /sch?_ssn=; seller is then required and keyword becomes a label only.", "default": "search" }, "seller": { "title": "Seller username", "type": "string", "description": "Required when mode=seller (unless seedSeller=true): the eBay seller username whose live inventory to collect (e.g. 'cocosprinkles')." }, "seedSeller": { "title": "Auto-pick seller (seedSeller)", "type": "boolean", "description": "mode=seller + seller empty: pick the best verified seller for this market from the worker's built-in catalog + runtime seed pool instead of requiring a name.", "default": false }, "minSellerFeedback": { "title": "Min seller feedback (seed candidates)", "minimum": 0, "type": "integer", "description": "Optional floor on seller feedbackCount when picking a seed seller from the runtime pool; verified catalog seeds are always eligible." }, "keyword": { "title": "Search keyword", "type": "string", "description": "What to search for (e.g. 'iphone 15', 'gaming laptop', 'air fryer'). Required for mode=search; a label only for mode=seller.", "default": "iphone 15" }, "market": { "title": "eBay market (country site)", "enum": [ "US", "GB", "DE", "FR", "IT", "ES", "AU", "CA", "NL", "AT", "CH", "IE", "PL", "BE", "HK", "SG", "MY" ], "type": "string", "description": "Which eBay country site to scrape. Controls host, currency, and the worker's exit country.", "default": "US" }, "country": { "title": "Country (DEPRECATED — use market)", "type": "string", "description": "Deprecated legacy alias for market; kept for backward compatibility. Must match market when both are set." }, "category": { "title": "L1 category", "enum": [ "all", "motors", "antiques", "art", "baby", "books", "business-industrial", "cameras-photo", "cell-phones", "fashion", "coins", "collectibles", "computers", "electronics", "crafts", "dolls-bears", "movies-tv", "entertainment-memorabilia", "health-beauty", "home-garden", "jewelry-watches", "music", "musical-instruments", "pet-supplies", "pottery-glass", "real-estate", "specialty-services", "sporting-goods", "sports-memorabilia", "stamps", "tickets", "toys-hobbies", "travel", "video-games", "everything-else" ], "type": "string", "description": "eBay top-level category. Use categoryId to override with any deeper category ID.", "default": "all" }, "categoryId": { "title": "eBay Category ID (override)", "type": "string", "description": "Optional raw eBay category ID (_sacat). When set, overrides the L1 category enum. Example: '9355'." }, "maxResults": { "title": "Max results per keyword", "minimum": 1, "maximum": 500, "type": "integer", "description": "Most eBay listing rows to collect for this keyword. Default 70; larger numbers remain supported, up to 500. The run stops at your maximum total charge. Free Apify plan: up to 200 rows per run and 10 runs of this Actor.", "default": 70 }, "condition": { "title": "Condition filter", "enum": [ "", "new", "refurbished", "used" ], "type": "string", "description": "Filter eBay by item condition.", "default": "" }, "buyItNow": { "title": "Buy It Now only", "type": "boolean", "description": "Only show Buy It Now listings (exclude auctions).", "default": false }, "minPrice": { "title": "Min price", "type": "number", "description": "Minimum price in the market currency." }, "maxPrice": { "title": "Max price", "type": "number", "description": "Maximum price in the market currency." }, "sortBy": { "title": "Sort by", "enum": [ "best_match", "price_asc", "price_desc", "newly_listed", "ending_soonest" ], "type": "string", "description": "How to sort eBay results.", "default": "best_match" }, "enrichDetails": { "title": "Enrich detail pages (seller leads)", "type": "boolean", "description": "Default on. Fetches each item's /itm/{id} detail page to add seller identity (username, store name, feedback count, positive rate), JSON-LD price, and city-level item location. Every delivered row gets its own detail page (one extra page load per row); if the run nears its time limit, the remaining rows keep their search-card fields and the warnings say detail_enrich_partial. eBay exposes no phone/email (contact is login-gated intermediated messaging); absence is reported in leadAbsences.", "default": true }, "workerBaseUrl": { "title": "Worker base URL (optional)", "type": "string", "description": "Override the worker route for this run. Defaults to Actor env WORKER_BASE_URL (the control-plane route https://worker.opendata.best/b/ebay-com). Host must be localhost or a name in ALLOWED_WORKER_HOSTS (worker.opendata.best when unset). Arbitrary hosts such as example.com are rejected so WORKER_AUTH is not sent off-fleet. Leave empty." } } }, "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 } } } } } } } } } }