{
  "openapi": "3.0.1",
  "info": {
    "title": "eBay Listings Scraper & Price Tracker",
    "description": "eBay listings scraper and price tracker: eBay prices from search results on 9 marketplaces — price, strike-through price, condition, buying format, shipping, ships-from country, units sold, rating and image. Track price changes between runs. One flat row per listing, no personal data.",
    "version": "0.1",
    "x-build-id": "sBDggL6fWBbbWHxvA"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/myth84~ebay-search-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-myth84-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/myth84~ebay-search-scraper/runs": {
      "post": {
        "operationId": "runs-sync-myth84-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/myth84~ebay-search-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-myth84-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",
        "properties": {
          "searchQueries": {
            "title": "Search keywords",
            "type": "array",
            "description": "Enter one search per line, as you would type it in the eBay search box, e.g. <code>wireless earbuds</code> or <code>laptop stand</code>. Each search gets its own results, up to the maximum number of listings below. Default <code>wireless earbuds</code>: it only serves runs started without any keyword or URL; with search URLs alone, only the URLs are searched.",
            "default": [
              "wireless earbuds"
            ],
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "eBay search URLs",
            "type": "array",
            "description": "Paste one or more eBay search result URLs copied from your browser (<code>https://www.ebay.com/sch/i.html?_nkw=...</code>, any eBay domain); their category and filter parameters are kept and the URL's domain decides the marketplace. The sorting and filters below are applied on top only when you set them. Default empty: keywords are enough for most searches.",
            "items": {
              "type": "string",
              "pattern": "^https?://([a-z0-9-]+\\.)*ebay\\.[a-z.]+/sch/"
            },
            "default": []
          },
          "marketplace": {
            "title": "Marketplace",
            "enum": [
              "US",
              "UK",
              "DE",
              "FR",
              "IT",
              "ES",
              "NL",
              "CA",
              "AU"
            ],
            "type": "string",
            "description": "eBay site to search: the domain, the currency and the language of the results. US, UK, Germany and France were validated at build time; the other sites follow the same page layout and will be confirmed at the first runs. Default US: ebay.com in US dollars.",
            "default": "US"
          },
          "maxResults": {
            "title": "Maximum listings per search",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Stop each search (keywords or URL) after this many unique listings, from 1 to 1,000; you are never charged for more. A result page holds up to 240 listings (see Listings per page). Default 100: the top of the results, usually in a single page; the form is prefilled with 20 for a quick first run.",
            "default": 100
          },
          "sortBy": {
            "title": "Sort by",
            "enum": [
              "best-match",
              "price-asc",
              "price-desc",
              "newly-listed",
              "ending-soonest"
            ],
            "type": "string",
            "description": "Order of the results. Best Match (eBay's default) and price + shipping lowest first were validated at build time; price highest first, newly listed and ending soonest use eBay's public URL parameters and are not verified yet. Default best-match: eBay's own order, the one a shopper sees.",
            "default": "best-match"
          },
          "condition": {
            "title": "Condition",
            "enum": [
              "any",
              "new",
              "used"
            ],
            "type": "string",
            "description": "eBay's condition filter: any, new (validated at build time) or used (not verified yet). Each card's condition is in <code>attributes.condition</code> (normalized grade: new, open_box, used, refurbished or for_parts) and <code>attributes.conditionText</code> (eBay's label as displayed); both are absent when the card shows no condition label. Default any: no condition filter.",
            "default": "any"
          },
          "buyingFormat": {
            "title": "Buying format",
            "enum": [
              "all",
              "buy-it-now",
              "auction"
            ],
            "type": "string",
            "description": "eBay's buying-format filter: all listings, Buy It Now only (validated at build time) or auctions only (not verified yet). The format of each card is always in <code>attributes.listingFormat</code>. Default all: no buying-format filter.",
            "default": "all"
          },
          "freeShippingOnly": {
            "title": "Free shipping only",
            "type": "boolean",
            "description": "Keep only listings with free shipping (eBay's own filter, not verified yet). The free-shipping flag of each card is always in the <code>shippingFree</code> column. Default off: every listing, whatever its shipping cost.",
            "default": false
          },
          "priceMin": {
            "title": "Min price",
            "minimum": 0,
            "maximum": 1000000000,
            "type": "number",
            "description": "Keep only listings priced at least this amount, in the marketplace currency, decimals allowed, e.g. <code>10</code> for 10 USD on ebay.com (eBay's own filter <code>_udlo</code>, not verified yet). Leave empty for no minimum."
          },
          "priceMax": {
            "title": "Max price",
            "minimum": 0,
            "maximum": 1000000000,
            "type": "number",
            "description": "Keep only listings priced at most this amount, in the marketplace currency, decimals allowed, e.g. <code>50</code> for 50 USD on ebay.com (eBay's own filter <code>_udhi</code>, not verified yet); it must be at least Min price. Leave empty for no maximum."
          },
          "categoryId": {
            "title": "Category ID",
            "minimum": 1,
            "maximum": 999999999,
            "type": "integer",
            "description": "Search only one eBay category: its numeric id, e.g. <code>112529</code> (Headphones on ebay.com), the number after <code>_sacat=</code> or in <code>/b/&lt;name&gt;/&lt;id&gt;</code> in an eBay URL; each row's leaf category is in <code>attributes.leafCategoryId</code>. eBay's own filter (<code>_sacat</code>), not verified yet. Leave empty for all categories; a pasted URL keeps its own category unless you set one here."
          },
          "excludeWords": {
            "title": "Exclude words",
            "type": "array",
            "description": "Words or phrases that the listings must not contain, one per line, e.g. <code>case</code> or <code>screen protector</code>: each one is added to the search words with eBay's minus sign (<code>-case</code>, <code>-\"screen protector\"</code>), also on pasted URLs. eBay's own search syntax, not verified yet. Default empty: nothing is excluded.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "itemLocation": {
            "title": "Item location",
            "enum": [
              "any",
              "domestic",
              "continent",
              "worldwide"
            ],
            "type": "string",
            "description": "Where the items are located, eBay's own filter (<code>LH_PrefLoc</code>, not verified yet): anywhere (eBay default, no filter), in the marketplace's country only, in its continent or region, or worldwide. The ships-from country of each listing is always in the <code>shipsFrom</code> column. A pasted URL keeps its own location filter unless you set one here. Default any: no location filter.",
            "default": "any"
          },
          "includeSponsored": {
            "title": "Include sponsored listings",
            "type": "boolean",
            "description": "eBay mixes about 7 sponsored listings into each page of 32. Keep them (they are flagged in the isSponsored column) or skip them. On ebay.fr the page carries no sponsored flag: every listing is kept and isSponsored is null. Default on: sponsored listings are real offers shown in eBay's results.",
            "default": true
          },
          "resultsPerPage": {
            "title": "Listings per page",
            "enum": [
              "240",
              "120",
              "60",
              "default"
            ],
            "type": "string",
            "description": "Listings requested per result page: 240, 120, 60 or eBay's default page of 32. Default 240: about 7 times fewer pages than eBay's page of 32, so fewer requests and a faster run; if the first page of a search with this setting is unusable twice, the search falls back to eBay's page size on its own. Choose eBay default to reproduce exactly what the mobile site shows.",
            "default": "240"
          },
          "maxPages": {
            "title": "Maximum pages per search",
            "minimum": 1,
            "maximum": 200,
            "type": "integer",
            "description": "Safety cap on the number of result pages read for one search, from 1 to 200. The scraper also stops at the last page, at maxResults, or when two consecutive pages bring no new listing. Default 50: enough for 1,000 listings even with eBay's page of 32.",
            "default": 50
          },
          "monitorPrices": {
            "title": "Monitor prices",
            "type": "boolean",
            "description": "Off (default): every listing is returned and the four monitoring columns stay null. On: every listing is compared with the previous run of the same search, by listing id and marketplace, and maxResults becomes the number of listings compared per search.",
            "default": false
          },
          "onlyChanges": {
            "title": "Return only changes",
            "type": "boolean",
            "description": "With price monitoring on: return and charge only the new listings and the listings whose price changed since the previous run; a run without any change succeeds with an empty dataset. Default off: every compared listing is returned with its changeType (new, price_changed, unchanged). Turn it on for scheduled runs.",
            "default": false
          },
          "monitorStoreName": {
            "title": "Monitoring store",
            "pattern": "^[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?$",
            "type": "string",
            "description": "Name of the key-value store, in your account, that keeps the previous prices (one record per search), e.g. <code>earbuds-daily</code>. Runs sharing a name share the records; use one name per schedule when two schedules run the same search with different settings. Letters, digits and dashes only, at most 63 characters; upper case is lowered. Default ebay-price-monitor: one store for all your monitoring runs.",
            "default": "ebay-price-monitor"
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Apify residential proxies (default, required for eBay). Leave the proxy country empty: the proxy then exits in the marketplace's country, so that prices come in the marketplace currency (eBay converts prices into the currency of the visitor's country). A country set here is kept as is. You can also provide your own residential proxy URLs.",
            "default": {
              "useApifyProxy": true,
              "apifyProxyGroups": [
                "RESIDENTIAL"
              ]
            }
          },
          "maxRequests": {
            "title": "Max page requests",
            "minimum": 1,
            "maximum": 5000,
            "type": "integer",
            "description": "Safety cap on the number of result pages fetched in one run, all searches included, from 1 to 5,000. Default 500: a cap against runaway runs, far above what a search needs (1,000 listings take about 5 pages of 240).",
            "default": 500
          },
          "delayMs": {
            "title": "Delay between pages",
            "minimum": 0,
            "maximum": 30000,
            "type": "integer",
            "description": "Pause between two page requests of the same search, in milliseconds, from 0 to 30,000. Increase it if you get blocked; 0 disables the pause. Default 1500 (1.5 s): the pace of the validation runs.",
            "default": 1500
          },
          "debugStoreHtml": {
            "title": "Store raw HTML pages",
            "type": "boolean",
            "description": "Debugging only: save every fetched page in the run's key-value store. Slows the run down and uses storage. Default off: only useful to investigate a parsing problem.",
            "default": false
          },
          "debugSendAccept": {
            "title": "Send an Accept header",
            "type": "boolean",
            "description": "Debugging only: send a browser-like Accept header with every request. Off by default because the validated requests sent only Accept-Language; turn it on only to test eBay's reaction.",
            "default": false
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}