{ "openapi": "3.0.1", "info": { "title": "eBay Product Scraper", "description": "Scrape eBay products from search queries or start URLs. Optionally enrich each listing with full product-page details.", "version": "1.0", "x-build-id": "5oEWgeVrGgbqW9w4L" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rigelbytes~ebay-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rigelbytes-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/rigelbytes~ebay-scraper/runs": { "post": { "operationId": "runs-sync-rigelbytes-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/rigelbytes~ebay-scraper/run-sync": { "post": { "operationId": "run-sync-rigelbytes-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", "properties": { "startUrls": { "title": "Start URLs", "type": "array", "description": "eBay search, category/browse, or item URLs (e.g. https://www.ebay.com/sch/i.html?_nkw=bike, https://www.ebay.com/b/Cars-Trucks/6001/bn_1865117, https://www.ebay.com/itm/389640259363). When provided, these URLs are used instead of building a search from queries and filters.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "searchQueries": { "title": "Search Queries", "type": "array", "description": "Product search terms (e.g. \"bike\", \"iphone 13\"). Used only when Start URLs are empty. Combine with category, location, and the filters below.", "items": { "type": "string" } }, "marketplace": { "title": "Marketplace / Location", "enum": [ "EBAY_US", "EBAY_UK", "EBAY_DE", "EBAY_AU", "EBAY_CA", "EBAY_FR", "EBAY_IT", "EBAY_ES", "EBAY_AT", "EBAY_CH", "EBAY_IE", "EBAY_NL", "EBAY_BE", "EBAY_PL", "EBAY_SG", "EBAY_HK" ], "type": "string", "description": "eBay site used for search queries and filters. Start URLs keep the host from the URL.", "default": "EBAY_US" }, "category": { "title": "Category", "enum": [ "0", "550", "2984", "267", "12576", "625", "15032", "9355", "11450", "11116", "1", "58058", "293", "14339", "237", "6000", "6001", "6024", "45100", "172008", "26395", "11700", "281", "11232", "11233", "619", "1281", "870", "10542", "888", "177831", "64482", "220", "1249", "99" ], "type": "string", "description": "eBay category applied to constructed searches. Ignored when Start URLs are set.", "default": "0" }, "buyingFormat": { "title": "Buying Format", "enum": [ "all", "buy_it_now", "auction", "best_offer" ], "type": "string", "description": "Limit constructed searches to Buy It Now, Auction, or Best Offer listings.", "default": "all" }, "condition": { "title": "Condition", "enum": [ "any", "new", "open_box", "certified_refurbished", "seller_refurbished", "used", "for_parts" ], "type": "string", "description": "Item condition filter for constructed searches.", "default": "any" }, "sortBy": { "title": "Sort By", "enum": [ "best_match", "ending_soonest", "newly_listed", "price_shipping_lowest", "price_shipping_highest", "nearest" ], "type": "string", "description": "How to sort constructed search results.", "default": "best_match" }, "itemLocation": { "title": "Item Location", "enum": [ "default", "domestic", "worldwide", "local" ], "type": "string", "description": "Prefer items located in the selected marketplace country, worldwide, or near a postal code.", "default": "default" }, "zipCode": { "title": "ZIP / Postal Code", "type": "string", "description": "Postal code used for nearby / local searches (e.g. \"10001\", \"SW1A 1AA\")." }, "distance": { "title": "Distance", "minimum": 0, "type": "integer", "description": "Search radius around the ZIP / postal code. Used with Item Location = Nearby." }, "minPrice": { "title": "Minimum Price", "minimum": 0, "type": "number", "description": "Exclude listings below this price on constructed searches." }, "maxPrice": { "title": "Maximum Price", "minimum": 0, "type": "number", "description": "Exclude listings above this price on constructed searches." }, "soldListings": { "title": "Sold Listings", "type": "boolean", "description": "When enabled, scrape completed/sold listings instead of active ones (constructed searches only).", "default": false }, "maxItems": { "title": "Max Products", "minimum": 0, "type": "integer", "description": "Maximum number of products to scrape across all URLs and queries (0 = unlimited).", "default": 0 }, "includeProductDetails": { "title": "Include Product Details", "type": "boolean", "description": "When enabled, open each item page for description, images, item specifics, seller, and shipping. Charged as the product-details event in addition to each dataset item.", "default": false }, "detailConcurrency": { "title": "Detail Concurrency", "minimum": 1, "maximum": 15, "type": "integer", "description": "How many product-detail fetches to run at the same time. Each worker uses its own rotating proxy. Higher is faster.", "default": 8 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings. Apify Residential proxies are recommended for reliable eBay access.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }