{ "openapi": "3.0.1", "info": { "title": "eBay Scraper — Official API: Search, Details & Prices", "description": "Search eBay listings, fetch detailed item info and monitor new arrivals via the official eBay Buy Browse API. No browser, no proxy, no login — just fast, reliable structured data.", "version": "0.1", "x-build-id": "sqEiewTlb2NIuvjj4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/commanding_hotdog~ebay-api-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-commanding_hotdog-ebay-api-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/commanding_hotdog~ebay-api-scraper/runs": { "post": { "operationId": "runs-sync-commanding_hotdog-ebay-api-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/commanding_hotdog~ebay-api-scraper/run-sync": { "post": { "operationId": "run-sync-commanding_hotdog-ebay-api-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": { "mode": { "title": "Mode", "enum": [ "search", "details" ], "type": "string", "description": "search = search listings by keywords/categories; details = fetch full details for specific items." }, "queries": { "title": "Search queries", "type": "array", "description": "Keywords to search for. Each query is executed separately and results are merged (deduplicated by itemId).", "items": { "type": "string" } }, "categoryIds": { "title": "Category IDs", "type": "array", "description": "eBay category IDs to narrow the search (comma-separated in the API call). Optional.", "items": { "type": "string" } }, "gtin": { "title": "GTIN / UPC", "type": "string", "description": "Search by Global Trade Item Number (UPC only). Optional — at least one of queries / categoryIds / gtin / epid must be provided in search mode." }, "epid": { "title": "ePID", "type": "string", "description": "Search by eBay Product ID. Optional." }, "sellers": { "title": "Sellers filter", "type": "array", "description": "Only return items from these seller usernames. Optional.", "items": { "type": "string" } }, "itemUrls": { "title": "Item URLs (details mode)", "type": "array", "description": "eBay item URLs to fetch details for. Supports any eBay domain: /itm/386123456789 or /itm/slug/386123456789?...", "items": { "type": "string" } }, "itemIds": { "title": "Item IDs (details mode)", "type": "array", "description": "eBay item IDs to fetch details for. Supports v1|123|0 format and plain numeric legacy IDs.", "items": { "type": "string" } }, "marketplace": { "title": "eBay marketplace", "enum": [ "EBAY_US", "EBAY_GB", "EBAY_DE", "EBAY_FR", "EBAY_IT", "EBAY_ES", "EBAY_AT", "EBAY_BE", "EBAY_NL", "EBAY_IE", "EBAY_CH", "EBAY_PL", "EBAY_CA", "EBAY_AU", "EBAY_HK", "EBAY_SG" ], "type": "string", "description": "Which eBay marketplace to query. Determines currency and default item-location filter." }, "minPrice": { "title": "Min price", "type": "number", "description": "Minimum item price in the marketplace currency. Optional." }, "maxPrice": { "title": "Max price", "type": "number", "description": "Maximum item price in the marketplace currency. Optional." }, "conditions": { "title": "Conditions", "type": "array", "description": "Filter by item condition. Leave empty for all conditions.", "items": { "type": "string", "enum": [ "NEW", "USED", "UNSPECIFIED" ] } }, "buyingOptions": { "title": "Buying options", "type": "array", "description": "Filter by buying format. Leave empty for all formats.", "items": { "type": "string", "enum": [ "FIXED_PRICE", "AUCTION", "BEST_OFFER" ] } }, "freeShippingOnly": { "title": "Free shipping only", "type": "boolean", "description": "Only return items with free shipping (maxDeliveryCost:0)." }, "returnsAcceptedOnly": { "title": "Returns accepted only", "type": "boolean", "description": "Only return items where the seller accepts returns." }, "searchInDescription": { "title": "Search in description", "type": "boolean", "description": "Also match the query against the item description, not just the title." }, "sort": { "title": "Sort order", "enum": [ "bestMatch", "priceAsc", "priceDesc", "newlyListed" ], "type": "string", "description": "Sort order for search results. bestMatch = eBay default relevance ranking." }, "maxItems": { "title": "Max items", "type": "integer", "description": "Maximum total number of items to return for this run." }, "includeDetails": { "title": "Include details for search results", "type": "boolean", "description": "For each search result, also call the item-detail API and emit a detail record. Costs more but gives full descriptions and specs." }, "newItemsOnly": { "title": "Monitoring — new items only", "type": "boolean", "description": "Only output item IDs never seen before. The seen set is persisted in a Key-Value Store across runs, so this turns the actor into a new-arrival monitor." }, "shipToCountry": { "title": "Ship-to country", "type": "string", "description": "Country code for the shipping-cost calculation context (e.g. US). Required for calculated-shipping items to return delivery cost and estimates." }, "shipToZip": { "title": "Ship-to ZIP / postal code", "type": "string", "description": "ZIP or postal code for the shipping-cost calculation context (e.g. 10001)." }, "ebayAppId": { "title": "eBay App ID (Client ID)", "type": "string", "description": "Your eBay Developer App ID (Client ID) for OAuth 2.0. Falls back to the EBAY_APP_ID environment variable if left empty." }, "ebayCertId": { "title": "eBay Cert ID (Client Secret)", "type": "string", "description": "Your eBay Developer Cert ID (Client Secret) for OAuth 2.0. Falls back to the EBAY_CERT_ID environment variable if left empty." }, "requestConcurrency": { "title": "Request concurrency", "type": "integer", "description": "Number of parallel detail requests. Lower is gentler on the API rate limit." } } }, "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 } } } } } } } } } }