{
  "openapi": "3.0.1",
  "info": {
    "title": "eBay Search Scraper",
    "description": "Scrape eBay.com search results with title, price, shipping cost, condition, seller location, quantity sold and a sponsored flag. Filter by category, condition, price, auction or Buy It Now and free shipping, sort like eBay, and page through many keywords in one run.",
    "version": "1.0",
    "x-build-id": "CReyjc7dCglHyBDb6"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/thescrappa~ebay-search-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-thescrappa-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/thescrappa~ebay-search-scraper/runs": {
      "post": {
        "operationId": "runs-sync-thescrappa-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/thescrappa~ebay-search-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-thescrappa-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": [
          "queries"
        ],
        "properties": {
          "queries": {
            "title": "Search queries",
            "minItems": 1,
            "maxItems": 100,
            "type": "array",
            "description": "Keywords to search on eBay.com, one per entry. An entry can also set its own filters, for example a different price range or category.",
            "items": {
              "type": "object",
              "required": [
                "query"
              ],
              "properties": {
                "query": {
                  "title": "Keywords",
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 255,
                  "description": "Keywords as you would type them into the eBay search box, for example coffee maker.",
                  "editor": "textfield"
                },
                "category": {
                  "title": "Category ID",
                  "type": "integer",
                  "minimum": 0,
                  "description": "eBay category ID, for example 38250 for Coffee, Tea & Espresso Makers. Leave empty or use 0 for all categories.",
                  "editor": "number"
                },
                "condition": {
                  "title": "Condition",
                  "type": "array",
                  "uniqueItems": true,
                  "items": {
                    "type": "string",
                    "enum": [
                      "1000",
                      "1500",
                      "1750",
                      "2000",
                      "2010",
                      "2020",
                      "2030",
                      "2500",
                      "3000",
                      "7000"
                    ],
                    "enumTitles": [
                      "New",
                      "Open box",
                      "New with defects",
                      "Certified refurbished",
                      "Excellent refurbished",
                      "Very good refurbished",
                      "Good refurbished",
                      "Seller refurbished",
                      "Used",
                      "For parts or not working"
                    ]
                  },
                  "description": "Only listings in these conditions. Select one or more. Leave empty for any condition.",
                  "editor": "select"
                },
                "price_min": {
                  "title": "Minimum price",
                  "type": "number",
                  "minimum": 0,
                  "description": "Lowest item price in US dollars, without shipping.",
                  "editor": "number"
                },
                "price_max": {
                  "title": "Maximum price",
                  "type": "number",
                  "minimum": 0,
                  "description": "Highest item price in US dollars, without shipping.",
                  "editor": "number"
                },
                "buy_it_now": {
                  "title": "Buy It Now only",
                  "type": "boolean",
                  "description": "Only fixed-price Buy It Now listings.",
                  "editor": "checkbox"
                },
                "auction": {
                  "title": "Auctions only",
                  "type": "boolean",
                  "description": "Only auction listings.",
                  "editor": "checkbox"
                },
                "free_shipping": {
                  "title": "Free shipping only",
                  "type": "boolean",
                  "description": "Only listings that eBay marks with free shipping.",
                  "editor": "checkbox"
                },
                "preferred_location": {
                  "title": "Item location",
                  "type": "string",
                  "enum": [
                    "1",
                    "3",
                    "2"
                  ],
                  "enumTitles": [
                    "US only",
                    "North America",
                    "Worldwide"
                  ],
                  "description": "Where the item is located. Leave empty for the eBay default.",
                  "editor": "select"
                },
                "location_postal": {
                  "title": "Postal code",
                  "type": "string",
                  "maxLength": 20,
                  "description": "US ZIP code used for delivery prices and the Distance sort, for example 10001.",
                  "editor": "textfield"
                },
                "sort": {
                  "title": "Sort by",
                  "type": "string",
                  "enum": [
                    "12",
                    "1",
                    "10",
                    "15",
                    "16",
                    "7"
                  ],
                  "enumTitles": [
                    "Best Match",
                    "Ending soonest",
                    "Newly listed",
                    "Price + shipping: lowest first",
                    "Price + shipping: highest first",
                    "Distance: nearest first"
                  ],
                  "description": "Order of the results, as on eBay. Leave empty for Best Match.",
                  "editor": "select"
                },
                "per_page": {
                  "title": "Results per page",
                  "type": "string",
                  "enum": [
                    "60",
                    "120",
                    "240"
                  ],
                  "enumTitles": [
                    "60",
                    "120",
                    "240"
                  ],
                  "description": "Listings per eBay result page. Larger pages need fewer requests for the same number of listings. Defaults to 60.",
                  "editor": "select"
                }
              }
            }
          },
          "category": {
            "title": "Category ID",
            "minimum": 0,
            "type": "integer",
            "description": "eBay category ID, for example 38250 for Coffee, Tea & Espresso Makers. Leave empty or use 0 for all categories."
          },
          "condition": {
            "title": "Condition",
            "uniqueItems": true,
            "type": "array",
            "description": "Only listings in these conditions. Select one or more. Leave empty for any condition.",
            "items": {
              "type": "string",
              "enum": [
                "1000",
                "1500",
                "1750",
                "2000",
                "2010",
                "2020",
                "2030",
                "2500",
                "3000",
                "7000"
              ],
              "enumTitles": [
                "New",
                "Open box",
                "New with defects",
                "Certified refurbished",
                "Excellent refurbished",
                "Very good refurbished",
                "Good refurbished",
                "Seller refurbished",
                "Used",
                "For parts or not working"
              ]
            }
          },
          "price_min": {
            "title": "Minimum price",
            "minimum": 0,
            "type": "number",
            "description": "Lowest item price in US dollars, without shipping."
          },
          "price_max": {
            "title": "Maximum price",
            "minimum": 0,
            "type": "number",
            "description": "Highest item price in US dollars, without shipping."
          },
          "buy_it_now": {
            "title": "Buy It Now only",
            "type": "boolean",
            "description": "Only fixed-price Buy It Now listings."
          },
          "auction": {
            "title": "Auctions only",
            "type": "boolean",
            "description": "Only auction listings."
          },
          "free_shipping": {
            "title": "Free shipping only",
            "type": "boolean",
            "description": "Only listings that eBay marks with free shipping."
          },
          "preferred_location": {
            "title": "Item location",
            "enum": [
              "1",
              "3",
              "2"
            ],
            "type": "string",
            "description": "Where the item is located. Leave empty for the eBay default."
          },
          "location_postal": {
            "title": "Postal code",
            "maxLength": 20,
            "type": "string",
            "description": "US ZIP code used for delivery prices and the Distance sort, for example 10001."
          },
          "sort": {
            "title": "Sort by",
            "enum": [
              "12",
              "1",
              "10",
              "15",
              "16",
              "7"
            ],
            "type": "string",
            "description": "Order of the results, as on eBay. Leave empty for Best Match."
          },
          "per_page": {
            "title": "Results per page",
            "enum": [
              "60",
              "120",
              "240"
            ],
            "type": "string",
            "description": "Listings per eBay result page. Larger pages need fewer requests for the same number of listings. Defaults to 60."
          },
          "maxResults": {
            "title": "Maximum Results",
            "minimum": 1,
            "maximum": 5000,
            "type": "integer",
            "description": "Maximum dataset items to save across this entire run.",
            "default": 100
          },
          "maxPages": {
            "title": "Maximum Pages",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "Maximum pages to request for each batch entry.",
            "default": 1
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}