{ "openapi": "3.0.1", "info": { "title": "eBay.de Listings Scraper", "description": "Scrape live eBay.de listings by keyword or search URL: price, shipping, condition, seller rating, private or commercial seller, watchers and units sold. 14 eBay sites. Export to JSON, CSV or Excel.", "version": "0.0", "x-build-id": "IlwPFKFj8K2wpMaj1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nice_dev~ebay-listings-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nice_dev-ebay-listings-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/nice_dev~ebay-listings-scraper/runs": { "post": { "operationId": "runs-sync-nice_dev-ebay-listings-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/nice_dev~ebay-listings-scraper/run-sync": { "post": { "operationId": "run-sync-nice_dev-ebay-listings-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": { "startUrls": { "title": "Start URLs", "maxItems": 1000, "type": "array", "description": "eBay search-result URLs (all filters set on the site are kept, pagination is automatic), single item URLs (always read on their item page, charged the item-page price) or seller feedback URLs (https://www.ebay.de/fdbk/feedback_profile/: that seller's sales, see Sold prices). When this list is not empty, the search fields below (keywords, sellers, site, category) are ignored; filters, caps and monitoring still apply. Max 1 000 URLs.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "query": { "title": "Search keyword", "maxLength": 200, "type": "string", "description": "Free-text search, exactly as typed on eBay (e.g. `iphone 13`). Can stay empty with Sellers, Start URLs or Sellers' sold prices; with none of them there is nothing to search (eBay shows no listings without a keyword or a seller, a category alone included) and the run stops at once." }, "searchQueries": { "title": "More search keywords", "maxItems": 100, "uniqueItems": true, "type": "array", "description": "Several keywords in one run: one search per keyword. Added to **Search keyword**; listings found by several searches are saved once.", "default": [], "items": { "type": "string" } }, "keywordMatch": { "title": "Keyword match", "enum": [ "allWords", "anyWords", "exactPhrase", "exactWords" ], "type": "string", "description": "How eBay matches your keyword — the keyword option of its own advanced search. **All words** is eBay's default: when a search finds few or no listings, eBay pads it with results matching fewer words — those are left out and never charged. **Any of the words** widens the search. **Exact phrase** and **Exact words** are stricter and pad nothing. A pasted search URL (Start URLs) keeps its own setting.", "default": "allWords" }, "ebaySite": { "title": "eBay site", "enum": [ "ebay.de", "ebay.at", "ebay.ch", "ebay.com", "ebay.co.uk", "ebay.fr", "ebay.it", "ebay.es", "ebay.nl", "ebay.be", "ebay.pl", "ebay.ie", "ebay.ca", "ebay.com.au" ], "type": "string", "description": "Which eBay marketplace to search. Prices and shipping are returned in that site's currency. With Start URLs, their own site is used (one site per run).", "default": "ebay.de" }, "categoryId": { "title": "Category ID", "pattern": "^[0-9]{0,10}$", "maxLength": 10, "type": "string", "description": "Restrict the search to one eBay category, by its numeric ID (the `_sacat=` value in an eBay search URL, e.g. `9355` for mobile phones). Empty = all categories." }, "sellers": { "title": "Sellers", "maxItems": 50, "uniqueItems": true, "type": "array", "description": "Only listings from these eBay sellers, by user name (e.g. `rebuy-shop`). Each seller is searched with every keyword (keywords × sellers, max 500). Empty = all sellers.", "default": [], "items": { "type": "string" } }, "maxItems": { "title": "Max listings", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Maximum number of listings to save for the whole run (after deduplication and filters). 0 = no limit.", "default": 100 }, "maxItemsPerQuery": { "title": "Max listings per search", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Cap for EACH search (keyword × seller, or search URL), so that the first search cannot use up the whole **Max listings** budget. 0 = no per-search cap.", "default": 0 }, "extractDetails": { "title": "Extract details", "type": "boolean", "description": "Open each item page (1 extra request per listing) for all photos, item specifics, brand / EAN, categories, quantity available, the seller's block (shop, profile link, units sold, detailed ratings) and — for commercial sellers — their legal details. Off = results-card fields only: one request per results page of up to 240 listings, cheaper and much faster. The description text needs **Include description** as well.", "default": false }, "includeDescription": { "title": "Include description", "type": "boolean", "description": "Also read the description text (1 MORE request per listing, on top of **Extract details**). eBay serves it in a separate page, never in the item page: off, the **description** column is empty and **descriptionUrl** points at that page.", "default": false }, "includePriceSummary": { "title": "Price summary per search", "type": "boolean", "description": "At the end of the run, sum up the prices of each search: number of listings, lowest, highest, mean, median, 10th / 25th / 75th / 90th percentiles, standard deviation and total, per currency, with and without shipping (plus how many auctions and free-shipping listings). Computed from the listings this run saved (after your filters; listings eBay only padded the search with are left out), for each search with at least 5 priced listings. Saved in the **PRICE_SUMMARY** record of the run's key-value store (Output tab). Charged once per search summed up, never for a search with too few prices. No extra request to eBay.", "default": false }, "includeSellerContact": { "title": "Seller contact (commercial sellers)", "type": "boolean", "description": "With **Extract details**, fill `sellerLegal` with the legal details a commercial seller publishes on its item page (company name, address, phone, e-mail, VAT and register numbers). Charged as a separate `seller-contact` event, only for listings where they are found (private sellers have none). Off = `sellerLegal` is empty. No extra request to eBay. Ticked alone, it gives nothing unless **Extract details** is on or an item URL is pasted in Start URLs: the run says so in its log.", "default": false }, "includeSellerReviews": { "title": "Seller reviews", "type": "boolean", "description": "With **Extract details**, add in `sellerReviews` the buyers' reviews of the seller the item page shows (up to 16: rating, masked buyer and score, period, verified purchase, comment, and the item each is about). Charged per review delivered (`seller-review` event); nothing for a listing without any. No extra request to eBay.", "default": false }, "salesSellers": { "title": "Sellers' sold prices", "maxItems": 50, "uniqueItems": true, "type": "array", "description": "eBay user names of sellers (e.g. `aix-axore`) whose recent sales you want, with the price paid. Runs with or without a search: with a search keyword, only the sales whose title matches it (eBay's own feedback search, over the last 5 years — Sales period is then applied by the Actor on each sale's period). Each sale is one result (`recordType` = `sale`). Not on ebay.be, which serves no feedback page: choose ebay.fr or ebay.nl (same sellers, same sales).", "default": [], "items": { "type": "string" } }, "maxSalesPerSeller": { "title": "Max sales per seller", "minimum": 0, "maximum": 40000, "type": "integer", "description": "Stop after this many sales read from one seller's feedback (kept or not by your filters: they are read 200 at a time). 0 = all of them, up to 40,000 (the last 5 years eBay keeps).", "default": 200 }, "salesPeriod": { "title": "Sales period", "enum": [ "all", "1m", "6m", "12m" ], "type": "string", "description": "Only the feedback left in this period (eBay's own filter on the feedback page; with a search keyword, which eBay does not combine with a period, the Actor keeps only the sales of the period).", "default": "all" }, "condition": { "title": "Condition", "uniqueItems": true, "type": "array", "description": "Item condition. Empty = any condition.", "items": { "type": "string", "enum": [ "new", "openBox", "refurbishedCertified", "refurbishedSeller", "used", "forPartsNotWorking" ], "enumTitles": [ "New (Neu)", "Open box (Neu: Sonstige)", "Certified refurbished (Zertifiziert generalüberholt)", "Seller refurbished (Generalüberholt)", "Used (Gebraucht)", "For parts / not working (Defekt)" ] }, "default": [] }, "buyingFormat": { "title": "Buying format", "enum": [ "all", "auction", "buyItNow", "bestOffer" ], "type": "string", "description": "Auction, fixed price (Sofort-Kaufen) or listings accepting a best offer.", "default": "all" }, "sellerType": { "title": "Seller type", "enum": [ "all", "private", "commercial" ], "type": "string", "description": "Private sellers (Privat) or commercial sellers (Gewerblich). This is an eBay.de distinction — commercial sellers must publish legal details and grant statutory returns.", "default": "all" }, "minPrice": { "title": "Min price", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "Lowest price, in the currency of the chosen eBay site." }, "maxPrice": { "title": "Max price", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "Highest price, in the currency of the chosen eBay site." }, "itemLocation": { "title": "Item location", "enum": [ "all", "site", "europe", "northAmerica", "worldwide" ], "type": "string", "description": "Where the item ships from — eBay's own filter. The region is the site's: European Union on the European sites, North America on ebay.com and ebay.ca, none on ebay.com.au; a region the site does not offer is refused.", "default": "all" }, "freeShipping": { "title": "Free shipping only", "type": "boolean", "description": "Only listings with free delivery (Kostenloser Versand).", "default": false }, "returnsAccepted": { "title": "Returns accepted only", "type": "boolean", "description": "Only listings that accept returns (Rücknahme akzeptiert).", "default": false }, "sortBy": { "title": "Sort by", "enum": [ "bestMatch", "newlyListed", "endingSoonest", "priceLowest", "priceHighest", "mostWatched" ], "type": "string", "description": "eBay's own sort order. It decides which listings come first when **Max listings** stops the run.", "default": "bestMatch" }, "excludeKeywords": { "title": "Exclude keywords", "maxItems": 50, "uniqueItems": true, "type": "array", "description": "Drop the listings whose title contains one of these words, e.g. `defekt` (case and accents ignored).", "default": [], "items": { "type": "string" } }, "titleMustMatchQuery": { "title": "Title must contain the keyword", "type": "boolean", "description": "Keep only the listings whose TITLE contains every word of their own search keyword (at least one with **Any of the words**). eBay also returns listings found through their item specifics or a \"compatible with\" list — a part number alone brings back accessories: this drops them before their item page is opened, so they are never charged as a listing (each listing checked is charged the filter fee, kept or not). Case, accents and punctuation are ignored (`18V-55` = `18v 55` = `18v55`), a number counts whole (`5Ah` is not in `7,5Ah`); in the keyword, `-word` (excluded by eBay) is skipped, `(a,b)` needs one of `a` / `b`, quotes and `*` are dropped. Listings from pasted item URLs are kept.", "default": false }, "minSellerFeedbackPercent": { "title": "Min seller rating", "minimum": 0, "maximum": 100, "type": "integer", "description": "Drop listings from sellers whose positive-feedback percentage is below this (e.g. `98`). Listings without a rating are dropped. 0 = no filter. With **Extract details**, a listing whose results card does not show the figure is decided on its item page." }, "minSellerFeedbackCount": { "title": "Min seller feedback count", "minimum": 0, "maximum": 10000000, "type": "integer", "description": "Drop listings from sellers with fewer ratings than this (e.g. `50`). Useful to skip brand-new accounts. Listings without a rating count are dropped. 0 = no filter. With **Extract details**, a listing whose results card does not show the figure is decided on its item page." }, "minWatchers": { "title": "Min watchers", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Only listings watched by at least this many people (e.g. `5`) — a live demand signal eBay still publishes (Beobachter). Listings without a watcher count are dropped. 0 = no filter. With **Extract details**, a listing whose results card does not show the figure is decided on its item page." }, "minSoldQuantity": { "title": "Min units already sold", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Only listings that already sold at least this many units (e.g. `1`), shown on multi-quantity fixed-price listings (N verkauft). Listings without a sold count are dropped. 0 = no filter. With **Extract details**, a listing whose results card does not show the figure is decided on its item page." }, "endingWithinHours": { "title": "Auctions ending within", "minimum": 1, "maximum": 720, "type": "integer", "description": "Only auctions whose end time is within this many hours (e.g. `24`). Leave empty to keep every listing." }, "onlyNew": { "title": "Only new listings", "type": "boolean", "description": "Skip the listings that a previous run (same **Memory key**) already delivered: they are not saved and not charged, and their item page is not even opened. First run = everything is new.", "default": false }, "stateKey": { "title": "Memory key", "pattern": "^[a-zA-Z0-9_-]{1,64}$", "maxLength": 64, "type": "string", "description": "Name of the memory used by **Only new listings**. Give each schedule / task its own key (e.g. `iphone-de`) so that they do not share their memory. Letters, digits, `-` and `_`.", "default": "default" }, "resetState": { "title": "Reset the memory", "type": "boolean", "description": "Forget everything remembered under this **Memory key** before the run: this run returns (and charges) every listing again. Untick it afterwards.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration (included proxy: paying users only)", "type": "object", "description": "Apify Proxy or your own proxies. Keep the default: the proxy this Actor needs is included in the price. On the Apify free plan the included proxy is not available: add your own proxy URLs, or the run stops at once with a message.", "default": { "useApifyProxy": true } }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum number of requests processed in parallel. eBay watches the pace: raising this makes blocks more likely, not the run faster.", "default": 2 }, "maxRequestsPerMinute": { "title": "Max requests per minute", "minimum": 5, "maximum": 600, "type": "integer", "description": "Global request budget per minute. With **Include description**, a listing page and its description count as ONE request here (the description is read together with its page): up to twice as many requests reach eBay. Lower it if the log shows eBay refusing requests.", "default": 60 }, "minRequestIntervalMs": { "title": "Min delay between requests", "minimum": 0, "maximum": 60000, "type": "integer", "description": "Smallest gap between two requests, in milliseconds. Unlike the per-minute budget, this spreads the requests evenly instead of letting them go out in a burst — the description of a listing is spaced the same way.", "default": 1000 }, "maxRequestRetries": { "title": "Max request retries", "minimum": 0, "maximum": 20, "type": "integer", "description": "Retries per request before it is marked as failed. Behind a proxy, a request eBay turns away is also retried on a new proxy session up to 3 times without using up these retries.", "default": 5 }, "debugLog": { "title": "Debug log", "type": "boolean", "description": "Include debug messages in the run log.", "default": false } } }, "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 } } } } } } } } } }