{
"openapi": "3.0.1",
"info": {
"title": "eBay Search Scraper — Listings, Categories & Filters",
"description": "Scrape eBay search results and category pages across every eBay domain: price, condition, buying format, shipping and seller for each listing. Filter by category, price range, condition, format and free shipping.",
"version": "1.0",
"x-build-id": "YncpzhhEFOndfRvNi"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/scrape.badger~ebay-search-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-scrape.badger-ebay-search-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/scrape.badger~ebay-search-scraper/runs": {
"post": {
"operationId": "runs-sync-scrape.badger-ebay-search-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/scrape.badger~ebay-search-scraper/run-sync": {
"post": {
"operationId": "run-sync-scrape.badger-ebay-search-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": [
"mode"
],
"properties": {
"mode": {
"title": "Mode",
"enum": [
"Search",
"Browse Category",
"Autocomplete",
"List Categories",
"List Markets"
],
"type": "string",
"description": "Which eBay call to run. Each mode uses a different subset of the fields below — the run tells you if a required one is missing.",
"default": "Search"
},
"query": {
"title": "Query",
"type": "string",
"description": "Search keywords. Required for: Search, Autocomplete."
},
"domain": {
"title": "Domain",
"enum": [
"com",
"co.uk",
"de"
],
"type": "string",
"description": "eBay marketplace domain (e.g. \"com\", \"co.uk\", \"de\"). Defaults to \"com\". Used by: Search, Browse Category, Autocomplete.",
"default": "com"
},
"category_id": {
"title": "Category id",
"type": "string",
"description": "Restrict the search to a category id. Required for: Browse Category."
},
"page": {
"title": "Page",
"type": "integer",
"description": "Page number (1-indexed). Defaults to 1. Used by: Search, Browse Category.",
"default": 1
},
"per_page": {
"title": "Per page",
"type": "integer",
"description": "Results per page (60, 120 or 240; clamped). Used by: Search, Browse Category."
},
"sort_by": {
"title": "Sort by",
"enum": [
"best_match",
"ending_soonest",
"newly_listed",
"price_low_to_high",
"price_high_to_low"
],
"type": "string",
"description": "Sort order (\"best_match\", \"ending_soonest\", \"newly_listed\", \"price_low_to_high\", \"price_high_to_low\"). Used by: Search, Browse Category."
},
"condition": {
"title": "Condition",
"enum": [
"new",
"open_box",
"refurbished",
"used",
"for_parts"
],
"type": "string",
"description": "Item condition (\"new\", \"open_box\", \"refurbished\", \"used\", \"for_parts\"). Used by: Search."
},
"buying_format": {
"title": "Buying format",
"enum": [
"auction",
"buy_it_now",
"best_offer"
],
"type": "string",
"description": "Buying format (\"auction\", \"buy_it_now\", \"best_offer\"). Used by: Search."
},
"min_price": {
"title": "Min price",
"type": "number",
"description": "Minimum price filter. Used by: Search, Browse Category."
},
"max_price": {
"title": "Max price",
"type": "number",
"description": "Maximum price filter. Used by: Search, Browse Category."
},
"free_shipping": {
"title": "Free shipping",
"type": "boolean",
"description": "Restrict to listings with free shipping. Used by: Search."
},
"max_items": {
"title": "Max items",
"minimum": 1,
"maximum": 100000,
"type": "integer",
"description": "Stop after this many records. The actor keeps paging until it hits this number or the site runs out of results. Each page is one charged event.",
"default": 100
}
}
},
"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
}
}
}
}
}
}
}
}
}
}