{ "openapi": "3.0.1", "info": { "title": "๐Ÿ›’โœจ eBay Search Scraper", "description": "๐Ÿ›’โœจ eBay Search Scraper pulls real-time marketplace data from eBay search results โ€” titles, prices, images, sellers, ratings, shipping, condition & item specifics. ๐Ÿ“ˆ Ideal for price tracking, market research, SEO, and product monitoring. ๐Ÿ”Ž Supports keywords, filters & pagination.", "version": "0.1", "x-build-id": "DP3IsgDGuF6XCWmLH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scraper-engine~ebay-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scraper-engine-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/scraper-engine~ebay-search-scraper/runs": { "post": { "operationId": "runs-sync-scraper-engine-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/scraper-engine~ebay-search-scraper/run-sync": { "post": { "operationId": "run-sync-scraper-engine-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": { "query": { "title": "๐Ÿ”Ž Search query", "type": "string", "description": "Type what you want to find โ€” products, brands, categories. This drives your search together with Country & filters below. Ignored when ๐Ÿ”— Direct item / search URLs is filled in. โ˜• Example: coffee, vintage camera, running shoes.", "default": "coffee" }, "startUrls": { "title": "๐Ÿ”— Direct item / search URLs", "type": "array", "description": "Optional โ€” skip ๐Ÿ”Ž Search query entirely. Paste direct eBay listing links (e.g. https://www.ebay.com/itm/) to fetch and enrich them straight away, and/or eBay search-result page links (e.g. https://www.ebay.com/sch/i.html?_nkw=camera) to scrape their listings. When this list has any values, it replaces Search query + Country + Filters + Pagination for building the search โ€” pure direct-URL/bulk mode. Mix both kinds freely in one list. Leave empty (default) to use ๐Ÿ”Ž Search query instead โ€” individual item listings end unpredictably (sold/removed), so a single hardcoded item URL can't be a reliable default the way a search query can.", "items": { "type": "string" } }, "domain": { "title": "๐ŸŒ Country (eBay site)", "enum": [ "ebay.com.au", "ebay.at", "ebay.ca", "ebay.fr", "ebay.de", "ebay.com.hk", "ebay.ie", "ebay.it", "ebay.com.my", "ebay.nl", "ebay.ph", "ebay.pl", "ebay.com.sg", "ebay.es", "ebay.ch", "ebay.co.uk", "ebay.com" ], "type": "string", "description": "Which eBay storefront to search โ€” prices, currency, and inventory follow the site you pick. ๐ŸŒ", "default": "ebay.com" }, "location": { "title": "๐Ÿ“ Item location filter", "enum": [ "1", "2", "3" ], "type": "string", "description": "eBay's own 'Item Location' search-results filter (the same 3-option control shown in eBay's sidebar) โ€” confirmed live to change which listings are returned. Note this filters by eBay's own ship-to/location logic, not strictly the seller's physical address (e.g. 'US Only' can still include overseas sellers who ship to the US). Default: US Only. โœˆ๏ธ", "default": "1" }, "sort": { "title": "โฌ†๏ธ Sort order", "enum": [ "12", "1", "10", "15", "16", "7", "3", "2" ], "type": "string", "description": "How listings are ranked โ€” best match, ending soon, newest, price high/low, distance, and more. ๐Ÿ“Š", "default": "12" }, "show_only": { "title": "๐Ÿท๏ธ Show only", "type": "array", "description": "Optional shortcuts: sold โœ”๏ธ, free shipping ๐Ÿšš, returns โ†ฉ๏ธ, deals ๐Ÿท๏ธ, authenticity โœ“, charity โค๏ธ, and more โ€” pick what matters to you.", "items": { "type": "string", "enum": [ "completed_items", "sold_items", "free_returns", "returns_accepted", "authorized_seller", "deals_and_savings", "sale_items", "listed_as_lots", "benefits_charity", "authenticity_guarantee", "free_shipping", "local_pickup" ], "enumTitles": [ "โœ… Completed items", "๐Ÿท๏ธ Sold items", "โ†ฉ๏ธ Free returns", "๐Ÿ“‹ Returns accepted", "โญ Authorized seller", "๐Ÿท๏ธ Deals & savings", "๐Ÿ’ธ Sale items", "๐Ÿ“ฆ Listed as lots", "โค๏ธ Benefits charity", "โœ“ Authenticity Guarantee", "๐Ÿšš Free shipping", "๐Ÿ“ Local pickup" ] } }, "buying_format": { "title": "๐Ÿ›’ Buying format", "enum": [ "Auction", "BIN", "BO" ], "type": "string", "description": "Auction ๐Ÿ”” ยท Buy It Now ๐Ÿ›๏ธ ยท Accepts offers ๐Ÿ’ฌ โ€” focus on how the listing is sold.", "default": "BIN" }, "max_pages": { "title": "๐Ÿ“„ Max pages to scrape", "minimum": 1, "type": "integer", "description": "How many search result pages to walk โ€” more pages = more candidate listings (then capped by Max listings). ๐Ÿ“š", "default": 1 }, "maxItems": { "title": "๐ŸŽฏ Max listings to scrape", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard cap on rows in your dataset this run โ€” great for samples (small) or big sweeps (up to limit). ๐Ÿ“ฅ", "default": 20 }, "useProxy": { "title": "๐Ÿ›ก๏ธ Use Apify Proxy", "type": "boolean", "description": "When on, the Actor can route traffic through Apify Proxy (configure groups below). ๐Ÿ”", "default": true }, "fetch_description_iframe": { "title": "๐Ÿ“œ Fetch full item description", "type": "boolean", "description": "Slower โฑ๏ธ but richer: pulls more seller description text when eBay exposes it. Great for detail-heavy listings.", "default": false }, "proxyConfiguration": { "title": "๐ŸŒ Proxy configuration", "type": "object", "description": "Fine-tune Apify Proxy (groups, sessions) for your workspace โ€” used when ๐Ÿ›ก๏ธ Use Apify Proxy is enabled." } } }, "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 } } } } } } } } } }