{ "openapi": "3.0.1", "info": { "title": "eBay Store Scraper", "description": "Extract public product listings and store details from eBay Stores.", "version": "1.0", "x-build-id": "V4jW6Wwbzt3AfcHCk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/codingfrontend~ebay-store-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-codingfrontend-ebay-store-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/codingfrontend~ebay-store-scraper/runs": { "post": { "operationId": "runs-sync-codingfrontend-ebay-store-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/codingfrontend~ebay-store-scraper/run-sync": { "post": { "operationId": "run-sync-codingfrontend-ebay-store-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": { "startUrls": { "title": "eBay source URLs", "type": "array", "description": "One or more public HTTPS eBay Store, seller listing, item, or search URLs. Legacy string entries remain accepted by the runtime.", "items": { "type": "object", "properties": { "url": { "title": "URL", "description": "Public HTTPS eBay URL.", "type": "string", "pattern": "^https://" } }, "required": [ "url" ], "additionalProperties": false }, "default": [ { "url": "https://www.ebay.com/str/" } ] }, "sourceUrls": { "title": "Legacy source URL alias", "maxItems": 50, "type": "array", "description": "Compatibility alias for startUrls.", "items": { "type": "string", "pattern": "^https://", "maxLength": 500 } }, "urls": { "title": "Legacy URLs alias", "maxItems": 50, "type": "array", "description": "Compatibility alias for startUrls.", "items": { "type": "string", "pattern": "^https://", "maxLength": 500 } }, "url": { "title": "Legacy single URL alias", "pattern": "^https://", "maxLength": 500, "type": "string", "description": "Compatibility alias for one start URL." }, "maxItems": { "title": "Maximum listings", "minimum": 1, "maximum": 500, "type": "integer", "description": "Global maximum of normal product records across all sources and pages.", "default": 50 }, "maxPages": { "title": "Maximum pages per source", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum pages fetched for each source URL. Page links are followed only on the same eBay route.", "default": 1 }, "pages": { "title": "Legacy page-limit alias", "minimum": 1, "maximum": 20, "type": "integer", "description": "Compatibility alias for maxPages." }, "startPage": { "title": "Starting page", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Optional one-based page number used when the source route supports a page query parameter.", "default": 1 }, "maxProducts": { "title": "Legacy maximum-products alias", "minimum": 1, "maximum": 500, "type": "integer", "description": "Compatibility alias for maxItems; maxItems takes precedence when both are supplied." }, "keyword": { "title": "Keyword filter", "maxLength": 120, "type": "string", "description": "Case-insensitive text filter over title, description, category, store, and seller fields." }, "searchQuery": { "title": "Legacy keyword alias", "maxLength": 120, "type": "string", "description": "Compatibility alias for keyword." }, "minPrice": { "title": "Minimum price", "minimum": 0, "maximum": 100000000, "type": "number", "description": "Keep records with a parsed price at or above this amount." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "maximum": 100000000, "type": "number", "description": "Keep records with a parsed price at or below this amount." }, "condition": { "title": "Condition", "maxLength": 80, "type": "string", "description": "Optional exact condition filter, such as New, Used, or Open Box." }, "sortBy": { "title": "Sort records", "enum": [ "source", "price_asc", "price_desc", "title" ], "type": "string", "description": "source preserves source order; other values sort the bounded collected set globally.", "default": "source" }, "deduplicate": { "title": "Deduplicate listings", "type": "boolean", "description": "Deduplicate globally by listing ID, then canonical URL.", "default": true }, "includeMedia": { "title": "Include listing media", "type": "boolean", "description": "Include only eBay-hosted listing image URLs when enabled.", "default": true }, "includeDiagnostics": { "title": "Include diagnostics", "type": "boolean", "description": "Emit minimal diagnostic rows for blocks, request failures, empty pages, and invalid fixtures. Diagnostics do not count toward maxItems.", "default": true }, "timeoutMs": { "title": "Request timeout (ms)", "minimum": 3000, "maximum": 120000, "type": "integer", "description": "Maximum time for each public page request.", "default": 20000 }, "requestTimeoutMs": { "title": "Legacy request-timeout alias", "minimum": 3000, "maximum": 120000, "type": "integer", "description": "Compatibility alias for timeoutMs; timeoutMs takes precedence." }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 3, "maximum": 120, "type": "integer", "description": "Compatibility alias for timeoutMs in seconds; do not combine with a different timeout value." }, "requestDelayMs": { "title": "Delay between pages (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Respectful delay between sequential page requests.", "default": 0 }, "maxRequestRetries": { "title": "Maximum request retries", "minimum": 0, "maximum": 2, "type": "integer", "description": "Bounded retries for transient 429/5xx or transport failures. Blocks are not retried indefinitely.", "default": 0 }, "maxConcurrency": { "title": "Concurrency", "minimum": 1, "maximum": 1, "type": "integer", "description": "This Actor processes pages in order and currently accepts only 1.", "default": 1 }, "userAgent": { "title": "User agent", "maxLength": 300, "type": "string", "description": "Ordinary user-agent sent to public eBay pages; do not use it to evade access controls.", "default": "Mozilla/5.0 (compatible; EbayStoreScraper/1.0)" } } }, "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 } } } } } } } } } }