{ "openapi": "3.0.1", "info": { "title": "eBay Product Listing Scraper", "description": "Extract product information from any eBay listing page, including search results, filtered listings, and category pages. Perfect for collecting detailed data like product titles, prices, shipping costs, and more.", "version": "0.0", "x-build-id": "jjT2tYSaMdRYPl41g" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/delicious_zebu~ebay-product-listing-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-delicious_zebu-ebay-product-listing-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/delicious_zebu~ebay-product-listing-scraper/runs": { "post": { "operationId": "runs-sync-delicious_zebu-ebay-product-listing-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/delicious_zebu~ebay-product-listing-scraper/run-sync": { "post": { "operationId": "run-sync-delicious_zebu-ebay-product-listing-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": { "keywords": { "title": "Keywords", "type": "array", "description": "Search terms — one per line. Each runs as a separate eBay search using the filters below. You can also enter an item number, or use eBay syntax like an \"exact phrase\" in quotes.", "items": { "type": "string" } }, "ebaySite": { "title": "eBay site", "enum": [ "www.ebay.com", "www.ebay.co.uk", "www.ebay.de", "www.ebay.fr", "www.ebay.it", "www.ebay.es", "www.ebay.ca", "www.ebay.com.au" ], "type": "string", "description": "Which eBay country site to run the search on. This changes the marketplace itself — currency, language, and which listings appear (e.g. eBay Germany shows German listings in EUR). Only affects the advanced search above; pasted URLs in Option 2 keep their own site. Note: on non-English sites, a few text fields (item location, shipping, sold, watchers) may occasionally be empty.", "default": "www.ebay.com" }, "keywordMatch": { "title": "Keyword match", "enum": [ "1", "2", "3", "4" ], "type": "string", "description": "How keywords are matched, same as eBay's advanced search.", "default": "1" }, "excludeKeywords": { "title": "Exclude words from your search", "type": "string", "description": "Skip listings that contain these words." }, "searchTitleDescription": { "title": "Title and description", "type": "boolean", "description": "Also search within item descriptions, not just titles.", "default": false }, "category": { "title": "In this category", "enum": [ "0", "550", "2984", "267", "12576", "625", "15032", "11450", "11116", "1", "58058", "293", "14339", "237", "45100", "99", "172008", "26395", "11700", "281", "11232", "11233", "619", "1281", "870", "10542", "316", "888", "64482", "260", "1305", "220", "3252", "1249", "6000" ], "type": "string", "description": "Limit the search to one main eBay category. For a sub-category, paste a category page URL under 'Option 2 — Search by URL' instead.", "default": "0" }, "minPrice": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Lowest price to include, in the currency of the eBay marketplace set by 'Proxy country' (e.g. USD for United States)." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Highest price to include, in the currency of the eBay marketplace set by 'Proxy country' (e.g. USD for United States)." }, "buyingFormat": { "title": "Buying format", "enum": [ "", "LH_BIN", "LH_Auction", "LH_BO", "LH_CAds" ], "type": "string", "description": "How the item is sold. Only one format applies at a time, matching eBay (which uses a single buying format). Leave as 'Any' to include all formats.", "default": "" }, "condition": { "title": "Condition", "enum": [ "", "1000", "3000", "10" ], "type": "string", "description": "Item condition, matching eBay's advanced search. 'New' and 'Used' are broad and work across all categories.", "default": "" }, "freeShipping": { "title": "Free shipping", "type": "boolean", "description": "Only show items with free shipping.", "default": false }, "soldItems": { "title": "Sold items", "type": "boolean", "description": "Show sold listings — useful for researching what actually sold and at what price.", "default": false }, "completedItems": { "title": "Completed items", "type": "boolean", "description": "Show completed (ended) listings, sold or unsold. For sold-only results, use 'Sold items' instead.", "default": false }, "locatedIn": { "title": "Located in", "enum": [ "", "1", "3", "77", "71", "101", "186", "2", "15", "16", "23", "146", "99", "193", "163", "104", "45", "92", "180", "127", "95", "149", "136", "31", "111", "196" ], "type": "string", "description": "Only items physically located in this country. Different from 'Proxy country', which sets the IP location used to load eBay's localized pages.", "default": "" }, "availableTo": { "title": "Available to (ships to)", "enum": [ "", "1", "3", "77", "71", "101", "186", "2", "15", "16", "23", "146", "99", "193", "163", "104", "45", "92", "180", "127", "95", "149", "136", "31", "111", "196" ], "type": "string", "description": "Only items that ship to this country. Different from 'Located in', which is where the item physically is.", "default": "" }, "sellers": { "title": "Sellers", "type": "string", "description": "eBay seller usernames (the seller's user ID), comma-separated, e.g. nike_store, best_deals_99. Use 'Sellers mode' below to keep only these sellers or to exclude them." }, "sellersMode": { "title": "Sellers mode", "enum": [ "1", "2" ], "type": "string", "description": "Whether the sellers above are included or excluded. Only takes effect when 'Sellers' is filled in.", "default": "1" }, "listingUrls": { "title": "Listing Page URLs", "uniqueItems": false, "type": "array", "description": "List of eBay listing page URLs (e.g., https://www.ebay.com/sch/i.html?_nkw=dresses or https://www.ebay.com/sch/i.html?_from=R40&_nkw=shoe&_sacat=0&Brand=Nike&rt=nc&Occasion=Wedding&_dcat=93427)", "items": { "type": "string" } }, "maxPages": { "title": "Max pages per URL", "minimum": 0, "type": "integer", "description": "How many result pages to scrape per URL. Each page has up to 240 items. Leave at 0 to scrape every page, or set a number to stop early (e.g. 5).", "default": 0 }, "sortBy": { "title": "Sort by", "enum": [ "12", "1", "10", "15", "16", "7" ], "type": "string", "description": "Order of the results, matching eBay's own \"Sort\" dropdown on the listing page. This setting overrides any sort order already present in your input URL.", "default": "12" }, "proxyCountry": { "title": "Proxy country", "enum": [ "US", "GB", "DE", "AU", "CA", "FR", "IT", "ES", "JP", "NL", "HK", "SG", "BR", "IN", "MX" ], "type": "string", "description": "Which country's eBay results to load. eBay shows different prices, shipping, currency, and listings by country, so pick the country whose view you want (e.g. United States to see what a US shopper sees). This is different from the 'Located in' filter, which is where items are physically located.", "default": "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 } } } } } } } } } }