{ "openapi": "3.0.1", "info": { "title": "eBay Product Scraper & Price Change Monitor", "description": "Search eBay listings, filter prices and condition, read item details, and track newly observed listings and price changes across repeated runs.", "version": "0.2", "x-build-id": "XL9U5BrpNoW7bNhQf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/luminar~ebay-product-scraper-price-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-luminar-ebay-product-scraper-price-monitor", "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/luminar~ebay-product-scraper-price-monitor/runs": { "post": { "operationId": "runs-sync-luminar-ebay-product-scraper-price-monitor", "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/luminar~ebay-product-scraper-price-monitor/run-sync": { "post": { "operationId": "run-sync-luminar-ebay-product-scraper-price-monitor", "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": [ "workflow", "marketplace", "maxListings", "maxPages", "maxBuyerChargeUsd" ], "properties": { "workflow": { "title": "Workflow", "enum": [ "snapshot", "monitor" ], "type": "string", "description": "Snapshot exports current listings. Monitor saves a first baseline, then returns newly observed listings and changed values on later runs.", "default": "snapshot" }, "queries": { "title": "Search terms", "type": "array", "description": "One search per line. Leave empty when using only saved search URLs or exact item URLs.", "items": { "type": "string" } }, "marketplace": { "title": "Marketplace", "enum": [ "US", "UK", "DE", "FR", "IT", "ES", "CA", "AU" ], "type": "string", "description": "Market used for search terms. A supplied URL keeps its own eBay market.", "default": "US" }, "searchUrls": { "title": "Search URLs", "type": "array", "description": "Optional public eBay search URLs with keyword or seller and supported filters. Clear search terms to use only these URLs.", "items": { "type": "string" } }, "itemUrls": { "title": "Item URLs", "type": "array", "description": "Optional exact public eBay item URLs. Clear search terms to check only this watchlist. Up to 50 URLs.", "items": { "type": "string" } }, "condition": { "title": "Condition", "enum": [ "all", "new", "used", "refurbished", "parts" ], "type": "string", "description": "Applies to search terms. Saved search URLs use their own filters.", "default": "all" }, "buyingFormat": { "title": "Buying format", "enum": [ "all", "buyNow", "auction" ], "type": "string", "description": "Auction prices are current bids, never final sale prices.", "default": "all" }, "minPrice": { "title": "Minimum item price", "minimum": 0, "maximum": 10000000, "type": "number", "description": "Optional lower item-price bound in the marketplace currency. Shipping and tax are separate." }, "maxPrice": { "title": "Maximum item price", "minimum": 0, "maximum": 10000000, "type": "number", "description": "Optional upper item-price bound in the marketplace currency." }, "sort": { "title": "Sort results", "enum": [ "bestMatch", "priceLow", "priceHigh", "newlyListed", "endingSoon" ], "type": "string", "description": "Select the source search order. Price sorts follow the marketplace ordering.", "default": "bestMatch" }, "freeShipping": { "title": "Free shipping only", "type": "boolean", "description": "Applies the source free-shipping filter. This is not a guarantee for a different delivery destination.", "default": false }, "categoryId": { "title": "Category ID", "type": "string", "description": "Optional eBay category number. Leave 0 for all categories.", "default": "0" }, "seller": { "title": "Seller username", "type": "string", "description": "Optional seller filter for keyword searches. Use the public seller username." }, "includeDetails": { "title": "Include item details", "type": "boolean", "description": "Also opens each discovered item for available brand, description, image URLs and shipping context. Adds a checked-page charge per successfully read detail. Unavailable details retain the basic listing and are marked unavailable.", "default": false }, "stateNamespace": { "title": "Watchlist name", "type": "string", "description": "Monitor only: reuse this name and identical targets, filters and limits to compare with the previous successful check.", "default": "default" }, "maxListings": { "title": "Maximum listings", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Global maximum across all targets, in input order. This is a limit, not a promise that the source has that many results.", "default": 20 }, "maxPages": { "title": "Maximum pages per search", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum search pages per target. Increase together with the listing limit to go beyond page one.", "default": 1 }, "maxBuyerChargeUsd": { "title": "Maximum charge (USD)", "minimum": 0.01, "maximum": 100, "type": "number", "description": "The complete requested workload must fit this ceiling before work starts. Increase the platform charge limit too when necessary.", "default": 2 } } }, "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 } } } } } } } } } }