{ "openapi": "3.0.1", "info": { "title": "Ebay Product Scraper", "version": "1.0", "x-build-id": "L9nMQImciuZHTVBaI" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mrdoe~ebay-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mrdoe-ebay-product-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/mrdoe~ebay-product-scraper/runs": { "post": { "operationId": "runs-sync-mrdoe-ebay-product-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/mrdoe~ebay-product-scraper/run-sync": { "post": { "operationId": "run-sync-mrdoe-ebay-product-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": [ "operation" ], "properties": { "operation": { "title": "Operation", "enum": [ "search", "productDetails" ], "type": "string", "description": "Which eBay data to scrape. One operation per run.", "default": "search" }, "query": { "title": "Search query (optional)", "type": "string", "description": "Keyword to search eBay, e.g. \"mechanical keyboard\". Used by the search operation. Defaults to a demo query if left blank.", "default": "mechanical keyboard" }, "queries": { "title": "Search queries - batch (optional)", "type": "array", "description": "Many keywords in one run. Wins over \"query\" when filled. Duplicates and blanks are dropped.", "items": { "type": "string" } }, "itemId": { "title": "Item number or item URL (optional)", "type": "string", "description": "An eBay item number (e.g. \"146721557193\") or a full eBay item URL. Used by the productDetails operation. Leave blank to have the Actor pick a current demo item." }, "itemIds": { "title": "Item numbers or URLs - batch (optional)", "type": "array", "description": "Many item numbers or item URLs in one run. Wins over \"itemId\" when filled.", "items": { "type": "string" } }, "sortBy": { "title": "Sort by (optional)", "enum": [ "best-match", "price-asc", "price-desc", "newly-listed", "ending-soonest" ], "type": "string", "description": "Applies to search." }, "condition": { "title": "Condition (optional)", "enum": [ "new", "open-box", "refurbished", "used", "for-parts" ], "type": "string", "description": "Applies to search." }, "buyItNow": { "title": "Buy It Now only (optional)", "type": "boolean", "description": "Applies to search. Excludes auction-only listings.", "default": false }, "minPrice": { "title": "Min price, USD (optional)", "minimum": 0, "type": "integer", "description": "Applies to search." }, "maxPrice": { "title": "Max price, USD (optional)", "minimum": 0, "type": "integer", "description": "Applies to search." }, "maxItems": { "title": "Max items (optional)", "minimum": 1, "type": "integer", "description": "Caps total rows returned across the whole run (applies to search; productDetails always returns one row per item). The first 10 rows of any run are free. Defaults to 20.", "default": 20 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "A residential proxy is strongly recommended - eBay rate-limits and challenges repeated traffic from one IP.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountryCode": "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 } } } } } } } } } }