{
  "openapi": "3.0.1",
  "info": {
    "title": "eBay Sold Listings Scraper",
    "description": "Get sold and completed eBay listings on nine marketplaces. Each row has the sale price, currency, shipping and sold date. Plus condition, buying format, bids and location. eBay only shows sold results to signed-in accounts. So you paste in your own eBay cookie. A run with no results costs nothing.",
    "version": "0.1",
    "x-build-id": "mHajgsWEH5mB0i9tD"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/dami_studio~ebay-sold-listings-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-dami_studio-ebay-sold-listings-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/dami_studio~ebay-sold-listings-scraper/runs": {
      "post": {
        "operationId": "runs-sync-dami_studio-ebay-sold-listings-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/dami_studio~ebay-sold-listings-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-dami_studio-ebay-sold-listings-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": {
          "query": {
            "title": "Search query",
            "type": "string",
            "description": "Keywords to search sold and completed listings for, for example vintage camera. Leave empty to get one labeled, uncharged sample row."
          },
          "site": {
            "title": "eBay marketplace",
            "enum": [
              "ebay.com",
              "ebay.ca",
              "ebay.co.uk",
              "ebay.de",
              "ebay.com.au",
              "ebay.fr",
              "ebay.it",
              "ebay.es",
              "ebay.ie"
            ],
            "type": "string",
            "description": "Which eBay site to search. Prices and sold dates come back in that marketplace's currency and date format.",
            "default": "ebay.com"
          },
          "condition": {
            "title": "Condition",
            "enum": [
              "new",
              "open box",
              "refurbished",
              "used",
              "parts"
            ],
            "type": "string",
            "description": "Optional condition filter, applied by eBay itself through LH_ItemCondition."
          },
          "soldFrom": {
            "title": "Sold on or after",
            "type": "string",
            "description": "Keep only listings whose sold date is on or after this date. Applied after parsing."
          },
          "soldTo": {
            "title": "Sold on or before",
            "type": "string",
            "description": "Keep only listings whose sold date is on or before this date. Applied after parsing."
          },
          "categoryId": {
            "title": "Category ID",
            "type": "string",
            "description": "Optional eBay category ID to restrict the search, for example 625 for cameras and photo."
          },
          "minPrice": {
            "title": "Minimum sold price",
            "minimum": 0,
            "type": "number",
            "description": "Applied by eBay through _udlo and re-checked on the parsed price."
          },
          "currency": {
            "title": "Currency",
            "type": "string",
            "description": "Keep only listings priced in this currency, for example USD or GBP. Useful on marketplaces that mix currencies."
          },
          "maxPrice": {
            "title": "Maximum sold price",
            "minimum": 0,
            "type": "number",
            "description": "Applied by eBay through _udhi and re-checked on the parsed price."
          },
          "maxItems": {
            "title": "Maximum listings",
            "minimum": 1,
            "maximum": 2000,
            "type": "integer",
            "description": "Maximum unique sold listings to return and charge for.",
            "default": 120
          },
          "maxPages": {
            "title": "Maximum pages",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "Result pages to walk. Each page carries about 200 sold listings.",
            "default": 3
          },
          "requestTimeoutSecs": {
            "title": "Request timeout seconds",
            "minimum": 5,
            "maximum": 60,
            "type": "integer",
            "description": "Maximum duration of each request.",
            "default": 30
          },
          "sessionCookie": {
            "title": "Your eBay session cookie",
            "type": "string",
            "description": "eBay shows sold and completed listings only to a signed-in account, so this Actor needs yours. Sign in to eBay in your browser, open the developer tools, go to the Network tab, reload the page, click the first request in the list and copy the whole Cookie request header. Paste all of it here, every cookie, not a chosen few. It is stored encrypted, sent only to eBay, and never written to the log or the dataset."
          },
          "maxSessions": {
            "title": "Session attempts per page",
            "minimum": 1,
            "maximum": 15,
            "type": "integer",
            "description": "eBay burns sessions. Each attempt warms a brand new session on a new proxy address before requesting the page.",
            "default": 8
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Optional. Leave empty to use Apify datacenter proxy with a fresh session per warm-up, which is what this actor is tuned for. Supply proxyUrls to use your own addresses. Residential proxy is never used."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}