{ "openapi": "3.0.1", "info": { "title": "Ebay Scraper", "description": "🛍️ Scrape eBay search results, seller stores, and item pages into clean, ready-to-use data.", "version": "0.0", "x-build-id": "Wdc6qV4JRaQrY2ydP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mido_99~ebay-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mido_99-ebay-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/mido_99~ebay-scraper/runs": { "post": { "operationId": "runs-sync-mido_99-ebay-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/mido_99~ebay-scraper/run-sync": { "post": { "operationId": "run-sync-mido_99-ebay-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": [ "mode" ], "properties": { "startUrls": { "title": "Start URLs", "type": "array", "description": "The eBay pages to scrape — search results, a store, an item, or a category page. Make sure each URL matches the Mode you select below.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "mode": { "title": "Mode", "enum": [ "search", "store", "item", "category" ], "type": "string", "description": "What kind of eBay page your Start URLs are: search results, a store, an item, or a category.", "default": "search" }, "sourceRunId": { "title": "Source run ID (chain from a previous run)", "type": "string", "description": "Optional: continue from a previous Search, Store, or Category run. Enter that run's ID and set Mode to 'Item' to fetch full details for every item it found." }, "maxResults": { "title": "Max results (total)", "minimum": 0, "type": "integer", "description": "Stop after collecting this many items IN TOTAL across every source (Start URLs + Search keywords). This is a combined cap, not per-URL. Set to 0 for no limit.", "default": 100 }, "maxPages": { "title": "Max pages per URL", "minimum": 1, "type": "integer", "description": "How many pages to go through per URL. Not used in Item mode.", "default": 5 }, "shipToCountry": { "title": "Ship-to country", "type": "string", "description": "Two-letter country code (e.g. US, GB, DE) — full country names also accepted (e.g. Germany).", "default": "US" }, "keywords": { "title": "Search keywords", "type": "array", "description": "Plain keywords to search eBay for. These run ALONGSIDE the Start URLs above — both sources are scraped in the same run. Combine with Search filters below to refine results. Search mode only.", "default": [], "items": { "type": "string" } }, "searchFilters": { "title": "Search filters", "type": "object", "description": "Optional filters applied to every keyword search URL. Ignored outside search mode.", "properties": { "minPrice": { "title": "Min price", "type": "integer", "minimum": 0, "description": "Lowest item price to include. Must be lower than Max price. Set to 0 for no lower limit.", "default": 0, "errorMessage": { "minimum": "Must be 0 or higher (0 = no lower limit)" } }, "maxPrice": { "title": "Max price", "type": "integer", "minimum": 0, "description": "Highest item price to include. Must be higher than Min price. Set to 0 for no upper limit.", "default": 0, "errorMessage": { "minimum": "Must be 0 or higher (0 = no upper limit)" } }, "condition": { "title": "Condition", "type": "array", "uniqueItems": true, "description": "Filter by item condition. For options not listed, paste an eBay URL with the filter applied into Start URLs.", "editor": "select", "default": [], "items": { "type": "string", "enum": [ "New", "Open box", "Used" ], "enumTitles": [ "New", "Open box", "Used" ] } }, "listingType": { "title": "Listing type", "type": "string", "description": "All, Buy It Now only, or Auction only.", "editor": "select", "enum": [ "all", "buyItNow", "auction" ], "enumTitles": [ "All", "Buy It Now", "Auction" ], "default": "all" }, "sortBy": { "title": "Sort by", "type": "string", "description": "Sort order for search results.", "editor": "select", "enum": [ "bestMatch", "priceAsc", "priceDesc", "endingSoonest", "newlyListed" ], "enumTitles": [ "Best Match", "Lowest price first", "Highest price first", "Ending soonest", "Newly listed" ], "default": "bestMatch" }, "soldItems": { "title": "Sold/completed listings only", "type": "boolean", "description": "Only show sold and completed listings (past ~90 days).", "default": false } }, "default": {} }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Select proxies to be used by actor. Residential proxy is priced higher per item than the default." } } }, "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 } } } } } } } } } }