{
  "openapi": "3.0.1",
  "info": {
    "title": "Surplex Scraper — Europe Industrial Auctions​‌​",
    "description": "Convert surplex.com auction activity into commercial intelligence: live bids, lot metadata and full attributes across industrial assets. Surface motivated sellers, benchmark realised prices and trigger sales outreach aligned to active auction windows.",
    "version": "1.3",
    "x-build-id": "hQlsRfBfmN5ev6RHQ"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/rastriq~surplex-auction-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-rastriq-surplex-auction-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/rastriq~surplex-auction-scraper/runs": {
      "post": {
        "operationId": "runs-sync-rastriq-surplex-auction-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/rastriq~surplex-auction-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-rastriq-surplex-auction-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": [
          "biddingStatus"
        ],
        "properties": {
          "runMode": {
            "title": "🚀 Run mode",
            "enum": [
              "sample",
              "full",
              "custom"
            ],
            "type": "string",
            "description": "Sample: fast test run, ~40s, 100 Construction & Earthmoving lots. Full: complete marketplace, all categories, respects maxItems if set (0 = unlimited). Custom: ignores presets, use all input fields directly.",
            "default": "sample"
          },
          "biddingStatus": {
            "title": "Auction status",
            "enum": [
              "BIDDING_OPEN",
              "BIDDING_CLOSED",
              "BIDDING_NOT_YET_OPENED"
            ],
            "type": "string",
            "description": "Which auctions to scrape.<br><b>Open</b>: live auctions with active bidding (for price tracking).<br><b>Closed</b>: finished auctions with final prices (for market analysis).<br><b>Upcoming</b>: future auctions not yet open (for scouting).",
            "default": "BIDDING_OPEN"
          },
          "maxItems": {
            "title": "Max lots",
            "minimum": 0,
            "type": "integer",
            "description": "Max lots to collect (0 = unlimited). Overridden by runMode if set.",
            "default": 0
          },
          "cat_metalworking": {
            "title": "Metalworking",
            "type": "boolean",
            "description": "CNC machines, lathes, milling, grinding, presses, lasers",
            "default": false
          },
          "cat_woodworking": {
            "title": "Woodworking",
            "type": "boolean",
            "description": "Saws, planers, CNC routers, panel saws, edge banders",
            "default": false
          },
          "cat_construction": {
            "title": "Construction & Earthmoving",
            "type": "boolean",
            "description": "Excavators, wheel loaders, cranes, concrete mixers, dozers",
            "default": false
          },
          "cat_transport": {
            "title": "Transport & Logistics",
            "type": "boolean",
            "description": "Forklifts, trucks, trailers, pallet trucks, reach stackers",
            "default": false
          },
          "cat_agricultural": {
            "title": "Agricultural",
            "type": "boolean",
            "description": "Tractors, harvesters, mowers, seeders, sprayers",
            "default": false
          },
          "cat_tools": {
            "title": "Tools",
            "type": "boolean",
            "description": "Hand tools, power tools, workshop equipment",
            "default": false
          },
          "cat_more_industrial": {
            "title": "More industrial categories",
            "type": "boolean",
            "description": "Food processing, packaging, printing, plastics, recycling",
            "default": false
          },
          "cat_retail_office": {
            "title": "Retail & Office",
            "type": "boolean",
            "description": "Shop fittings, shelving, office furniture, electronics",
            "default": false
          },
          "brand_caterpillar": {
            "title": "Caterpillar",
            "type": "boolean",
            "description": "Construction & mining equipment",
            "default": false
          },
          "brand_komatsu": {
            "title": "Komatsu",
            "type": "boolean",
            "description": "Construction & mining equipment",
            "default": false
          },
          "brand_liebherr": {
            "title": "Liebherr",
            "type": "boolean",
            "description": "Cranes, excavators, concrete tech",
            "default": false
          },
          "brand_volvo": {
            "title": "Volvo",
            "type": "boolean",
            "description": "Construction equipment & trucks",
            "default": false
          },
          "brand_jcb": {
            "title": "JCB",
            "type": "boolean",
            "description": "Backhoe loaders, excavators, telehandlers",
            "default": false
          },
          "brand_hitachi": {
            "title": "Hitachi",
            "type": "boolean",
            "description": "Excavators, wheel loaders",
            "default": false
          },
          "brand_john_deere": {
            "title": "John Deere",
            "type": "boolean",
            "description": "Agricultural & construction equipment",
            "default": false
          },
          "brand_kubota": {
            "title": "Kubota",
            "type": "boolean",
            "description": "Compact excavators, tractors, utility vehicles",
            "default": false
          },
          "brand_linde": {
            "title": "Linde",
            "type": "boolean",
            "description": "Forklifts & warehouse equipment",
            "default": false
          },
          "brand_still": {
            "title": "STILL",
            "type": "boolean",
            "description": "Forklifts & warehouse equipment",
            "default": false
          },
          "brand_jungheinrich": {
            "title": "Jungheinrich",
            "type": "boolean",
            "description": "Forklifts & warehouse equipment",
            "default": false
          },
          "brand_toyota": {
            "title": "Toyota",
            "type": "boolean",
            "description": "Forklifts & industrial equipment",
            "default": false
          },
          "brand_mazak": {
            "title": "Mazak",
            "type": "boolean",
            "description": "CNC lathes & machining centers",
            "default": false
          },
          "brand_jlg": {
            "title": "JLG",
            "type": "boolean",
            "description": "Aerial work platforms, boom lifts",
            "default": false
          },
          "brand_genie": {
            "title": "Genie",
            "type": "boolean",
            "description": "Aerial work platforms, scissor lifts",
            "default": false
          },
          "extraBrands": {
            "title": "Additional brands",
            "type": "array",
            "description": "Type additional brand names (case-insensitive). The Actor matches them against Surplex's brand catalog automatically.<br><br><b>Popular brands by sector:</b><br><b>Metalworking:</b> DMG MORI, TRUMPF, Okuma, Haas, Amada, Bystronic, Reishauer, ABB, KUKA<br><b>Construction:</b> Bobcat, Bomag, Mecalac, Atlas, Case, Takeuchi, Doosan, Terex, Wacker Neuson<br><b>Transport:</b> Mercedes-Benz, MAN, Iveco, Renault, Ford, Volkswagen, Hyster<br><b>Agricultural:</b> Claas, Fendt, New Holland, Massey Ferguson, Husqvarna<br><b>Tools:</b> Bosch, Hilti, Makita, DeWalt<br><b>Aerial platforms:</b> Haulotte, Skyjack, Manitou",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "country_de": {
            "title": "Germany (DE)",
            "type": "boolean",
            "description": "Largest Surplex market",
            "default": false
          },
          "country_nl": {
            "title": "Netherlands (NL)",
            "type": "boolean",
            "description": "Second largest market",
            "default": false
          },
          "country_it": {
            "title": "Italy (IT)",
            "type": "boolean",
            "description": "Southern European hub",
            "default": false
          },
          "country_be": {
            "title": "Belgium (BE)",
            "type": "boolean",
            "description": "Central European hub",
            "default": false
          },
          "country_fr": {
            "title": "France (FR)",
            "type": "boolean",
            "description": "French market",
            "default": false
          },
          "country_ro": {
            "title": "Romania (RO)",
            "type": "boolean",
            "description": "Eastern European market",
            "default": false
          },
          "country_pl": {
            "title": "Poland (PL)",
            "type": "boolean",
            "description": "Eastern European market",
            "default": false
          },
          "country_cz": {
            "title": "Czech Republic (CZ)",
            "type": "boolean",
            "description": "Central European market",
            "default": false
          },
          "country_at": {
            "title": "Austria (AT)",
            "type": "boolean",
            "description": "Austrian market",
            "default": false
          },
          "country_hr": {
            "title": "Croatia (HR)",
            "type": "boolean",
            "description": "Croatian market",
            "default": false
          },
          "country_es": {
            "title": "Spain (ES)",
            "type": "boolean",
            "description": "Spanish market",
            "default": false
          },
          "country_pt": {
            "title": "Portugal (PT)",
            "type": "boolean",
            "description": "Portuguese market",
            "default": false
          },
          "country_ch": {
            "title": "Switzerland (CH)",
            "type": "boolean",
            "description": "Swiss market",
            "default": false
          },
          "includeBidHistory": {
            "title": "Include bid history",
            "type": "boolean",
            "description": "Download the full bidding history per lot (buyer number, amount, timestamp). Useful for closed auctions analysis. Makes the run slower.",
            "default": true
          },
          "datasetName": {
            "title": "Named dataset",
            "type": "string",
            "description": "Optional named dataset for accumulating data across runs (e.g. for time-series tracking of open auctions)."
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Residential proxy recommended for large runs (1000+ lots)."
          },
          "outputSchema": {
            "title": "Output schema",
            "enum": [
              "english",
              "ftp28"
            ],
            "type": "string",
            "description": "Select 'ftp28' to output canonical Spanish field names required for FTP-28 pipeline integration.",
            "default": "english"
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}