{
"openapi": "3.0.1",
"info": {
"title": "EBAY: Search | Sold Prices |Store | Seller Pages (8 Markets)",
"description": "Unofficial eBay API to extract data from eBay search results and product details with our eBay Search Results and Listing Details Scraper. Perfect for market research, price tracking, and detailed product analysis—get all the information you need, in one go.",
"version": "0.0",
"x-build-id": "BUPP1gULKop8agmyx"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/memo23~apify-ebay-search-cheerio/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-memo23-apify-ebay-search-cheerio",
"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/memo23~apify-ebay-search-cheerio/runs": {
"post": {
"operationId": "runs-sync-memo23-apify-ebay-search-cheerio",
"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/memo23~apify-ebay-search-cheerio/run-sync": {
"post": {
"operationId": "run-sync-memo23-apify-ebay-search-cheerio",
"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",
"type": "array",
"description": "eBay URLs to scrape. Supports keyword/filter search pages (/sch/i.html?_nkw=...), seller pages (/usr/<seller>), store pages (/str/<store>) and single item pages (/itm/<id>) — on any supported marketplace domain (.com, .co.uk, .de, .fr, .it, .es, .ca, .com.au). Leave empty if you use the Search query field instead.",
"items": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"title": "URL of a web page",
"format": "uri"
}
}
}
},
"searchQuery": {
"title": "Search query",
"type": "string",
"description": "Keyword(s) to search, e.g. \"iphone 16 pro 256gb\". Supports eBay search syntax (quotes for exact match, minus to exclude). Leave empty if you provided Start URLs."
},
"marketplace": {
"title": "Marketplace",
"enum": [
"ebay.com",
"ebay.co.uk",
"ebay.de",
"ebay.fr",
"ebay.it",
"ebay.es",
"ebay.ca",
"ebay.com.au",
"ebay.nl",
"ebay.at",
"ebay.ch",
"ebay.ie",
"ebay.pl",
"ebay.com.hk",
"ebay.com.my",
"ebay.ph",
"ebay.com.sg"
],
"type": "string",
"description": "Which eBay regional site to scrape (affects currency, language and inventory). Applies to keyword searches and to pasted ebay.com URLs; a regional domain in a pasted URL (e.g. ebay.co.uk) always wins over this setting.",
"default": "ebay.com"
},
"mode": {
"title": "Listing mode",
"enum": [
"active",
"sold",
"both"
],
"type": "string",
"description": "What to scrape for keyword / search / seller / store URLs:
Active – current live listings (default).
Sold / completed – confirmed sold listings for price comps (eBay exposes roughly the last 90 days). Sold rows come straight from the search results (sold price, sold date, condition, shipping, image) without an extra detail request.
Both – runs an active search and a sold search for each URL (each respects Max number of items).",
"default": "active"
},
"condition": {
"title": "Condition",
"enum": [
"any",
"new",
"used",
"refurbished",
"open_box"
],
"type": "string",
"description": "Filter by item condition (keyword-search only).",
"default": "any"
},
"minPrice": {
"title": "Min price",
"type": "integer",
"description": "Lower price bound in the marketplace currency (keyword-search only). Leave empty for no minimum."
},
"maxPrice": {
"title": "Max price",
"type": "integer",
"description": "Upper price bound in the marketplace currency (keyword-search only). Leave empty for no maximum."
},
"sortBy": {
"title": "Sort by",
"enum": [
"best_match",
"ending_soon",
"newest",
"price_asc",
"price_desc"
],
"type": "string",
"description": "Result ordering for keyword searches.",
"default": "best_match"
},
"listingType": {
"title": "Listing type",
"enum": [
"all",
"auction",
"bin"
],
"type": "string",
"description": "Filter by buying format (keyword-search only).",
"default": "all"
},
"freeShipping": {
"title": "Free shipping only",
"type": "boolean",
"description": "Only return listings with free shipping (keyword-search only).",
"default": false
},
"returnsAccepted": {
"title": "Returns accepted only",
"type": "boolean",
"description": "Only return listings that accept returns (keyword-search only).",
"default": false
},
"seller": {
"title": "Seller",
"type": "string",
"description": "Limit a keyword search to a specific seller's username (eBay _ssn)."
},
"category": {
"title": "Category ID",
"type": "string",
"description": "Limit a keyword search to an eBay category by numeric category ID (eBay _sacat), e.g. 9355 for Cell Phones & Smartphones."
},
"detailedItems": {
"title": "Fetch full item details (active listings)",
"type": "boolean",
"description": "When ON (default), each ACTIVE listing's item page is fetched for item specifics, full description, gallery images and seller details — richer, but ~3× more requests. When OFF, active listings are returned straight from the search results (price, condition, shipping, image, availability) — much faster and cheaper. Sold listings are always returned from search results regardless of this setting.",
"default": true
},
"maxItems": {
"title": "Max number of items",
"type": "integer",
"description": "Maximum number of items to scrape (per search chain; in 'Both' mode the active and sold searches each return up to this many).",
"default": 1000
},
"maxConcurrency": {
"title": "Max Concurrency",
"type": "integer",
"description": "Maximum number of pages processed at the same time. Lower this (e.g. 3) if you hit eBay rate-limiting (HTTP 429); raise it for more speed on small runs.",
"default": 5
},
"minConcurrency": {
"title": "Min Concurrency",
"type": "integer",
"description": "Minimum number of pages that will be processed at the same time.",
"default": 1
},
"maxRequestRetries": {
"title": "Max Request Retries",
"type": "integer",
"description": "Number of times the crawler will retry a failed request before giving up.",
"default": 100
},
"monitoringMode": {
"title": "Run in monitoring mode where only newly listings compared to previous runs will be scraped",
"type": "boolean",
"description": "When enabled, the scraper will only return new items that haven't been seen in previous runs. Uses KeyValueStore to track seen items across runs.",
"default": false
},
"enablePriceMonitoring": {
"title": "Enable price monitoring",
"type": "boolean",
"description": "When enabled (requires Monitoring Mode), also returns items where the price has changed since the last run. Adds a 'priceChanged' flag to such items.",
"default": false
},
"proxy": {
"title": "Proxy configuration",
"type": "object",
"description": "Specifies proxy servers that will be used by the scraper in order to hide its origin.
For details, see Proxy configuration in README.",
"default": {
"useApifyProxy": true,
"apifyProxyGroups": [
"RESIDENTIAL"
],
"apifyProxyCountry": "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
}
}
}
}
}
}
}
}
}
}