{ "openapi": "3.0.1", "info": { "title": "eBay Search Scraper", "description": "Search eBay by keyword or paste a search link and get every result as clean data: title, price in the site's own currency, condition, format, shipping, seller and feedback, image and link. Sponsored ads are flagged and organic rank shown apart. Optionally attach full item details.", "version": "0.0", "x-build-id": "16mGOWd4uGhTtf9Nh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/apt_marble~ebay-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-apt_marble-ebay-search-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/apt_marble~ebay-search-scraper/runs": { "post": { "operationId": "runs-sync-apt_marble-ebay-search-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/apt_marble~ebay-search-scraper/run-sync": { "post": { "operationId": "run-sync-apt_marble-ebay-search-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", "required": [ "queries" ], "properties": { "queries": { "title": "Search terms or search links", "type": "array", "description": "What to search for. Enter one or more keywords (for example \"mechanical keyboard\"), or paste full eBay search result links — both work, mixed in the same list. When you paste a search link, its own filters (site, price range, condition, sort, category) are read from the link; anything you set below overrides them.", "items": { "type": "string" } }, "maxItemsPerQuery": { "title": "Results per search", "minimum": 1, "maximum": 2400, "type": "integer", "description": "How many results to collect for each search term. eBay serves up to 240 results per page and the actor pages through automatically until this number is reached or the results run out.", "default": 240 }, "condition": { "title": "Condition", "enum": [ "any", "new", "used", "refurbished" ], "type": "string", "description": "Limit results to a single item condition, or leave on Any.", "default": "any" }, "buyingFormat": { "title": "Buying format", "enum": [ "all", "buy-it-now", "auction" ], "type": "string", "description": "Limit results to Buy It Now listings or auctions, or leave on All.", "default": "all" }, "priceMin": { "title": "Minimum price", "minimum": 0, "maximum": 1000000, "type": "number", "description": "Only return listings priced at or above this amount, in the selected site's currency. Leave empty for no lower bound." }, "priceMax": { "title": "Maximum price", "minimum": 0, "maximum": 1000000, "type": "number", "description": "Only return listings priced at or below this amount, in the selected site's currency. Leave empty for no upper bound." }, "freeShippingOnly": { "title": "Free shipping only", "type": "boolean", "description": "Return only listings that offer free delivery.", "default": false }, "sort": { "title": "Sort results by", "enum": [ "best_match", "newly_listed", "price_asc", "price_desc", "ending_soonest" ], "type": "string", "description": "The order eBay returns results in. Best Match is eBay's default relevance ranking. Newly Listed shows the freshest listings first. The two price orders rank by price plus delivery, so the displayed item price is not strictly increasing.", "default": "best_match" }, "categoryId": { "title": "Category number (optional)", "type": "string", "description": "Restrict a keyword search to a single eBay category, given as its numeric id (for example 177 for PC Laptops & Netbooks). A category only works together with a search term — it is ignored on searches that have no keyword." }, "includeDetails": { "title": "Attach full item details", "type": "boolean", "description": "Open each result's own listing page and attach the complete record — full title, item specifics, all images, exact stock, seller reputation, returns and more. This reads one extra page per result, so it is slower and is charged separately; leave it off for a fast list of results.", "default": false }, "marketplace": { "title": "eBay site", "enum": [ "US", "UK", "DE", "AU", "CA", "FR", "IT", "ES" ], "type": "string", "description": "Which country's eBay site to search. Prices come back in that site's own currency. A pasted search link keeps its own site regardless of this choice.", "default": "US" }, "maxConcurrency": { "title": "Parallel work", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many results to work on at the same time when attaching full item details. Higher is faster, but eBay serves fewer complete pages when pushed hard. Leave at 4 unless you have a reason.", "default": 4 } } }, "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 } } } } } } } } } }