{ "openapi": "3.0.1", "info": { "title": "eBay Listings Scraper - Prices, Bids, Sellers & Item Specifics", "description": "Scrape active eBay listings by keyword, search URL, category, seller or item link: price, bids, time left, shipping, condition, seller score, sold count and sponsored flag; add item specifics, images, quantity and returns. 13 eBay sites, monitor mode. $0.09 per 1,000 listings, no start fee.", "version": "0.1", "x-build-id": "gPtpgpHD4bxeDM7Bx" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/topapi~ebay-listings-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-topapi-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/topapi~ebay-listings-scraper/runs": { "post": { "operationId": "runs-sync-topapi-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/topapi~ebay-listings-scraper/run-sync": { "post": { "operationId": "run-sync-topapi-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": { "keywords": { "title": "🔍 Keywords", "type": "array", "description": "What to search on eBay, one search per keyword, e.g. \"iphone 13\", \"rtx 4080\", \"lego 42115\". Each row says which keyword found it.", "items": { "type": "string" } }, "startUrls": { "title": "eBay URLs", "type": "array", "description": "eBay search URLs (/sch/i.html?_nkw=..., keyword and filters read from the URL), category pages (/b/... or /sch/9355/i.html), store pages (/str/...), seller pages (/usr/...) or item links (/itm/...).", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "sellers": { "title": "Sellers", "type": "array", "description": "eBay usernames, e.g. \"backinthebox\". See \"Seller mode\" for how they are used. Empty = any seller.", "items": { "type": "string" } }, "sellersMode": { "title": "Seller mode", "enum": [ "inventory", "only", "exclude" ], "type": "string", "description": "Inventory = each seller's own listings (with keywords: only those words). Only = one keyword search limited to these sellers. Exclude = keyword search without them.", "default": "inventory" }, "itemUrls": { "title": "Item links or ids", "type": "array", "description": "Item URLs or item numbers, e.g. \"https://www.ebay.com/itm/145829369846\" or \"145829369846\". Each gives one full row from the item page (listing + item details).", "items": { "type": "string" } }, "ebaySite": { "title": "eBay site", "enum": [ "ebay.com", "ebay.co.uk", "ebay.de", "ebay.fr", "ebay.it", "ebay.es", "ebay.ca", "ebay.com.au", "ebay.at", "ebay.ch", "ebay.ie", "ebay.nl", "ebay.pl" ], "type": "string", "description": "Which eBay marketplace to search. Prices come in that site's currency.", "default": "ebay.com" }, "categoryId": { "title": "Category id", "type": "string", "description": "eBay category id, e.g. \"9355\" (Cell Phones & Smartphones). With no keyword it lists the whole category. Empty = all categories." }, "itemCondition": { "title": "Condition", "enum": [ "any", "new", "used", "open_box", "refurbished", "certified_refurbished", "for_parts", "not_specified" ], "type": "string", "description": "Only listings in this condition.", "default": "any" }, "conditionId": { "title": "Condition id", "type": "string", "description": "Exact eBay condition ids instead, \"|\"-separated, e.g. \"1000|1500\" (1000 new, 1500 open box, 2000-2500 refurbished, 3000 used, 7000 for parts)." }, "buyingFormat": { "title": "Buying format", "enum": [ "all", "auction", "buyItNow", "acceptsOffers", "classifiedAds" ], "type": "string", "description": "Only listings in this format.", "default": "all" }, "minPrice": { "title": "Min price", "minimum": 0, "type": "number", "description": "Lowest item price, in the site's currency (eBay's price filter)." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "number", "description": "Highest item price, in the site's currency (eBay's price filter)." }, "sortBy": { "title": "Sort", "enum": [ "bestMatch", "endingSoonest", "newlyListed", "priceLowest", "priceHighest", "distance" ], "type": "string", "description": "eBay's sort order. Newly listed suits monitor mode; ending soonest suits auction tracking.", "default": "bestMatch" }, "freeShipping": { "title": "Free shipping only", "type": "boolean", "description": "Only listings with free shipping.", "default": false }, "returnsAccepted": { "title": "Returns accepted only", "type": "boolean", "description": "Only listings whose seller accepts returns.", "default": false }, "itemLocation": { "title": "Item location", "enum": [ "default", "domestic", "worldwide" ], "type": "string", "description": "Where the listed items are, as on eBay's search.", "default": "default" }, "locatedIn": { "title": "Located in (country)", "enum": [ "", "US", "GB", "DE", "FR", "IT", "ES", "CA", "AU", "AT", "BE", "NL", "IE", "CH", "PL", "JP", "CN", "HK", "SG", "MY", "IN", "NZ", "MX", "BR", "KR", "TW" ], "type": "string", "description": "Only items located in this country, e.g. GB on ebay.com. Overrides Item location." }, "availableTo": { "title": "Ships to (country)", "enum": [ "", "US", "GB", "DE", "FR", "IT", "ES", "CA", "AU", "AT", "BE", "NL", "IE", "CH", "PL", "JP", "CN", "HK", "SG", "MY", "IN", "NZ", "MX", "BR", "KR", "TW" ], "type": "string", "description": "Only items the seller ships to this country." }, "keywordMatch": { "title": "Keyword match", "enum": [ "all", "any", "exact", "exactAnyOrder" ], "type": "string", "description": "How eBay matches the keyword words.", "default": "all" }, "excludeKeywords": { "title": "Exclude words", "type": "array", "description": "Listings whose title has any of these words are left out (eBay's own exclude filter, then checked again), e.g. \"case\", \"broken\".", "items": { "type": "string" } }, "searchInDescription": { "title": "Search title and description", "type": "boolean", "description": "Match the keyword in the listing description too, not only the title.", "default": false }, "aspectFilter": { "title": "Item specifics filter", "type": "object", "description": "eBay item-specific filters, e.g. {\"Brand\": \"Apple\", \"Storage Capacity\": \"128 GB\"} or for cars {\"Model Year\": \"2018|2019\"}. Use the site's language (ebay.de: \"Marke\")." }, "titleMustMatchQuery": { "title": "Title must match the keyword", "type": "boolean", "description": "Keep only listings whose title has every word of the keyword (4+ word keywords allow one miss). Drops accessories eBay adds to a search.", "default": false }, "titleMustInclude": { "title": "Title must include", "type": "array", "description": "Keep only listings whose title has every one of these words, ignoring case and punctuation (18V-55 = 18v 55), e.g. \"256GB\".", "items": { "type": "string" } }, "excludeSellers": { "title": "Exclude sellers", "type": "array", "description": "eBay usernames whose listings are skipped.", "items": { "type": "string" } }, "skipSponsored": { "title": "Skip sponsored listings", "type": "boolean", "description": "Leave out listings eBay marks as Sponsored (each row carries isSponsored either way).", "default": false }, "minSellerFeedbackScore": { "title": "Min seller feedback score", "minimum": 0, "type": "integer", "description": "Skip sellers below this feedback count, e.g. 100. Cards that show no seller are kept (item details read it)." }, "minSellerPositivePercent": { "title": "Min seller positive %", "minimum": 0, "maximum": 100, "type": "number", "description": "Skip sellers below this positive-feedback percentage, e.g. 98.5." }, "minBids": { "title": "Min bids", "minimum": 0, "type": "integer", "description": "Only auctions with at least this many bids." }, "endingWithinHours": { "title": "Auctions ending within (hours)", "minimum": 1, "maximum": 720, "type": "integer", "description": "Only auctions that end within N hours. Pair it with Sort = ending soonest: the run stops paging past the window." }, "includePartialMatches": { "title": "Include \"fewer words\" matches", "type": "boolean", "description": "eBay pads small searches with \"Results matching fewer words\". Off (default) leaves them out.", "default": false }, "dedupeItemIds": { "title": "One row per listing", "type": "boolean", "description": "A listing found by two keywords or pages is delivered once.", "default": true }, "includeItemDetails": { "title": "➕ Item details (paid add-on)", "type": "boolean", "description": "Also read each listing's page: item specifics, all images, quantity available, watchers, returns, seller details, start and end time. +$0.0013 per listing that gets them.", "default": false }, "includeDescription": { "title": "Seller description text", "type": "boolean", "description": "With item details: add the seller's own description as plain text (one more request per item, no extra charge).", "default": false }, "monitorMode": { "title": "🔁 Monitor mode", "type": "boolean", "description": "Deliver only listings no earlier run delivered for the same search. Pairs with a schedule (hourly or daily).", "default": false }, "trackPriceChanges": { "title": "Also deliver price changes", "type": "boolean", "description": "In monitor mode, a known listing whose price changed is delivered again with changeType \"priceChanged\" and previousPrice.", "default": false }, "monitorStoreName": { "title": "Monitor memory name", "type": "string", "description": "Named key-value store that remembers delivered listings. Use one name per schedule.", "default": "ebay-listings-monitor" }, "resetMonitorState": { "title": "Reset monitor memory", "type": "boolean", "description": "Forget what earlier runs delivered for these searches and start over.", "default": false }, "maxItems": { "title": "Max listings", "minimum": 0, "type": "integer", "description": "Most rows this run delivers, across all searches. eBay shows up to about 10,000 results per search. 0 = no limit.", "default": 100 }, "maxItemsPerSearch": { "title": "Max per search", "minimum": 0, "type": "integer", "description": "Most rows per keyword, URL, seller or category. 0 = no per-search limit." }, "maxPages": { "title": "Max pages per search", "minimum": 0, "maximum": 200, "type": "integer", "description": "Most search pages read per search. 0 = until Max listings or the last page." }, "itemsPerPage": { "title": "Listings per request", "enum": [ "auto", "60", "120", "240" ], "type": "string", "description": "eBay page size. Auto = 60, which eBay answers most reliably past page 1 (it refuses deep 240-per-page paging far more often).", "default": "auto" }, "includeSummary": { "title": "Price summary", "type": "boolean", "description": "Write count, min, median, percentiles and max of prices per search, plus auction / free-shipping / sponsored shares, to the SUMMARY record. Free.", "default": true }, "compact": { "title": "Compact rows", "type": "boolean", "description": "Core fields only (25), sized for AI agents and MCP.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Default: Apify datacenter sessions first, residential in the site's country next. Choose groups here to use your own instead.", "default": { "useApifyProxy": true } }, "maxConcurrency": { "title": "Parallel item pages", "minimum": 1, "maximum": 6, "type": "integer", "description": "Item pages read at the same time when item details are on (each on its own paced session).", "default": 3 } } }, "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 } } } } } } } } } }