{ "openapi": "3.0.1", "info": { "title": "eBay Scraper – Listings, Prices, Auctions & Item Details", "description": "Scrape eBay search results & item pages on 12 marketplaces: price, bids, end time, shipping, condition, seller feedback, sold count, item specifics, images. Filters + URLs.", "version": "1.0", "x-build-id": "PbnyKKJHyB3GsQCuI" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ninhothedev~ebay-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ninhothedev-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/ninhothedev~ebay-scraper/runs": { "post": { "operationId": "runs-sync-ninhothedev-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/ninhothedev~ebay-scraper/run-sync": { "post": { "operationId": "run-sync-ninhothedev-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": { "searchQueries": { "title": "Search keywords", "type": "array", "description": "One or more eBay search terms (e.g. 'iphone 15', 'rolex submariner', 'lego 75192'). Each keyword is searched on the selected marketplace with the filters below. eBay operators work too: \"exact phrase\", -exclude, (a,b) for OR.", "items": { "type": "string" } }, "startUrls": { "title": "eBay URLs (optional)", "type": "array", "description": "Paste any eBay URL: search result pages (/sch/i.html?...), category or browse pages (/b/...), seller store pages (/str/...) or single item pages (/itm/123456789012). Search URLs keep all their own filters; item URLs are scraped with full details. Plain item IDs are accepted too.", "items": { "type": "string" } }, "marketplace": { "title": "eBay marketplace", "enum": [ "ebay.com", "ebay.co.uk", "ebay.de", "ebay.fr", "ebay.it", "ebay.es", "ebay.com.au", "ebay.ca", "ebay.at", "ebay.ch", "ebay.nl", "ebay.ie" ], "type": "string", "description": "Which eBay site to search for keywords. URLs use their own domain automatically.", "default": "ebay.com" }, "maxItems": { "title": "Max items", "minimum": 0, "type": "integer", "description": "Exact cap on the total number of listings saved across all keywords and URLs. 0 = no limit (eBay shows at most ~10,000 results per search).", "default": 20 }, "maxItemsPerQuery": { "title": "Max items per keyword / URL", "minimum": 0, "type": "integer", "description": "Optional cap per keyword or URL, useful when tracking many keywords. 0 = only the global limit applies.", "default": 0 }, "condition": { "title": "Condition", "type": "array", "description": "Only listings in these conditions. Leave empty for all.", "items": { "type": "string", "enum": [ "new", "open_box", "refurbished", "used", "for_parts" ], "enumTitles": [ "New", "Open box", "Refurbished (all grades)", "Used / pre-owned", "For parts or not working" ] }, "default": [] }, "buyingFormat": { "title": "Buying format", "enum": [ "all", "auction", "buy_it_now", "best_offer" ], "type": "string", "description": "Auctions only, Buy It Now only, or listings accepting Best Offer.", "default": "all" }, "minPrice": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Minimum item price in the marketplace currency." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Maximum item price in the marketplace currency." }, "sort": { "title": "Sort by", "enum": [ "best_match", "newest", "ending_soonest", "price_asc", "price_desc", "distance" ], "type": "string", "description": "Result order. 'Ending soonest' is ideal for auction sniping, 'Newly listed' for deal monitoring.", "default": "best_match" }, "categoryId": { "title": "Category ID", "type": "string", "description": "Optional eBay category ID (the number in category URLs, e.g. 9355 = Cell Phones & Smartphones, 31387 = Wristwatches). A category URL is accepted too." }, "itemLocation": { "title": "Item location", "enum": [ "default", "domestic", "regional", "worldwide" ], "type": "string", "description": "Where the item is located relative to the marketplace.", "default": "default" }, "locationCountry": { "title": "Located in country (ISO code)", "type": "string", "description": "Only items located in this country, 2-letter code: US, GB, DE, FR, IT, ES, AU, CA, CN, JP, HK, NL, AT, CH, PL, IE, BE, SE, KR, TW, IN, TR. Overrides 'Item location'." }, "freeShippingOnly": { "title": "Free shipping only", "type": "boolean", "description": "Only listings with free shipping/delivery.", "default": false }, "sellerUsername": { "title": "Seller username", "type": "string", "description": "Only listings from this eBay seller (user ID)." }, "excludeSponsored": { "title": "Exclude sponsored listings", "type": "boolean", "description": "Drop promoted (sponsored) results. Every row also has an is_sponsored flag.", "default": false }, "excludeFewerWordsMatches": { "title": "Stop at 'fewer words' results", "type": "boolean", "description": "eBay pads small result sets with 'Results matching fewer words' – loosely related items. Enabled = keep only real matches for keyword searches.", "default": true }, "includeDetails": { "title": "Scrape item details", "type": "boolean", "description": "Open every listing page to add item specifics (brand, model, MPN, UPC/EAN …), all images, seller feedback score & items sold, quantity available/sold, shipping, returns policy, item location and category path. One extra request per item – slower, same price.", "default": false }, "includeDescription": { "title": "Include description text", "type": "boolean", "description": "Also download the seller's full item description as plain text (requires 'Scrape item details').", "default": false }, "maxConcurrency": { "title": "Detail concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Parallel item-page requests when details are enabled.", "default": 3 }, "maxPages": { "title": "Max pages per search", "minimum": 0, "type": "integer", "description": "Safety limit on result pages per keyword/URL (60–240 items per page). 0 = until Max items is reached.", "default": 0 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "eBay blocks bots aggressively. Apify Proxy (datacenter) is used by default with session + browser-fingerprint rotation.", "default": { "useApifyProxy": true } }, "residentialFallback": { "title": "Automatic residential fallback", "type": "boolean", "description": "If eBay blocks the datacenter proxies repeatedly, switch to Apify residential proxies automatically so the run still finishes.", "default": true } } }, "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 } } } } } } } } } }