{
  "openapi": "3.0.1",
  "info": {
    "title": "eBay Marketplace Scraper",
    "description": "Export active eBay listings from keywords or public URLs across eight marketplaces, including prices, shipping, auctions, sellers, returns, images, and optional product details.",
    "version": "0.1",
    "x-build-id": "HwgEPOXnt3dBWbTZu"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/fetch_cat~ebay-marketplace-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-fetch_cat-ebay-marketplace-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/fetch_cat~ebay-marketplace-scraper/runs": {
      "post": {
        "operationId": "runs-sync-fetch_cat-ebay-marketplace-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/fetch_cat~ebay-marketplace-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-fetch_cat-ebay-marketplace-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": {
          "searchQueries": {
            "title": "Search queries",
            "maxItems": 50,
            "type": "array",
            "description": "Keywords to search on the selected eBay marketplace. Provide queries, start URLs, or both.",
            "items": {
              "type": "string",
              "minLength": 1,
              "maxLength": 500
            }
          },
          "startUrls": {
            "title": "eBay search or category URLs",
            "maxItems": 50,
            "type": "array",
            "description": "Up to 50 HTTPS eBay search or category URLs from supported marketplaces. Inline URLs only; remote URL-list imports are not supported. Queries and URLs together may contain at most 50 sources.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "marketplace": {
            "title": "Marketplace",
            "enum": [
              "US",
              "UK",
              "DE",
              "FR",
              "IT",
              "ES",
              "CA",
              "AU"
            ],
            "type": "string",
            "description": "Marketplace used for keyword searches. Start URLs are matched to their own domain automatically.",
            "default": "US"
          },
          "maxItemsPerQuery": {
            "title": "Maximum listings per query or URL",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "Stops each query or start URL after this many unique listings.",
            "default": 20
          },
          "maxPagesPerQuery": {
            "title": "Maximum pages per query or URL",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "Maximum eBay result pages to visit for each source.",
            "default": 2
          },
          "sort": {
            "title": "Sort order",
            "enum": [
              "best_match",
              "newly_listed",
              "ending_soonest",
              "price_low",
              "price_high"
            ],
            "type": "string",
            "description": "Order requested from eBay for keyword searches: best match, newly listed, ending soonest, or price plus shipping lowest/highest. Does not override a start URL's order or globally re-sort the combined dataset.",
            "default": "best_match"
          },
          "listingType": {
            "title": "Listing type",
            "enum": [
              "all",
              "auction",
              "buy_it_now",
              "best_offer"
            ],
            "type": "string",
            "description": "Limit keyword searches to auctions, Buy It Now, or Best Offer listings.",
            "default": "all"
          },
          "conditions": {
            "title": "Conditions",
            "maxItems": 20,
            "type": "array",
            "description": "Optional eBay condition filters. Supported shortcuts: new, open_box, refurbished, used, for_parts; numeric eBay condition IDs are also accepted.",
            "items": {
              "type": "string",
              "minLength": 1,
              "maxLength": 20
            },
            "default": []
          },
          "minPrice": {
            "title": "Minimum price",
            "minimum": 0,
            "type": "number",
            "description": "Minimum item price for keyword searches, in the selected marketplace currency. For start URLs, set price filters in the URL."
          },
          "maxPrice": {
            "title": "Maximum price",
            "minimum": 0,
            "type": "number",
            "description": "Maximum item price for keyword searches, in the selected marketplace currency. Must not be below Minimum price. For start URLs, set price filters in the URL."
          },
          "freeShippingOnly": {
            "title": "Free shipping only",
            "type": "boolean",
            "description": "Return only listings marked with free shipping for keyword searches.",
            "default": false
          },
          "includeDetails": {
            "title": "Enrich listing details",
            "type": "boolean",
            "description": "Visit each listing to add available item specifics, brand, model, identifiers, images, category path, quantity and return details. Availability varies; full seller descriptions and exact auction end timestamps are not extracted. This is slower and successful enrichment has a separate per-detail charge. Base listings are preserved if detail lookup fails or is skipped.",
            "default": false
          },
          "maxRequestRetries": {
            "title": "Maximum request retries",
            "minimum": 0,
            "maximum": 5,
            "type": "integer",
            "description": "Number of new-session retries for blocked or malformed eBay responses.",
            "default": 5
          },
          "connectionMode": {
            "title": "Connection",
            "enum": [
              "automatic",
              "direct"
            ],
            "type": "string",
            "description": "Automatic (the form prefill and omitted-input behavior) starts with the established residential proxy route, not direct-first access. Direct uses no proxy and never falls back to a paid route; eBay may block it. Retries remain limited by Maximum request retries. Valid explicit proxyConfiguration settings take precedence, including a customer proxy pool, managed groups/country, or an explicit opt-out. Invalid settings are rejected, not changed to Automatic. Never share private proxy credentials in an issue report."
          },
          "proxyConfiguration": {
            "title": "Saved/API proxy settings",
            "type": "object",
            "description": "Saved/API settings take precedence over Connection, including its form prefill. Supports useApifyProxy, apifyProxyGroups, apifyProxyCountry and proxyUrls. A nonempty customer pool stays on that pool; without a pool, useApifyProxy:false means direct. Managed settings preserve the chosen groups/country. Omission keeps the established residential route. Malformed supported values are rejected without a paid fallback. Do not include proxy URLs or credentials in public reports."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}