{
  "openapi": "3.0.1",
  "info": {
    "title": "PublicSurplus Scraper & Auction Monitor",
    "description": "Scrape PublicSurplus government surplus auctions by state, category, keyword, ZIP, or price, or run on a schedule as a new-lot monitor with Slack/email/webhook alerts.",
    "version": "0.1",
    "x-build-id": "XMuO8GtQN3lWrhvFY"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/scrapersdelight~publicsurplus-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-scrapersdelight-publicsurplus-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/scrapersdelight~publicsurplus-scraper/runs": {
      "post": {
        "operationId": "runs-sync-scrapersdelight-publicsurplus-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/scrapersdelight~publicsurplus-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-scrapersdelight-publicsurplus-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": {
          "searchType": {
            "title": "Search type",
            "enum": [
              "state",
              "category",
              "keyword",
              "zipcode",
              "all"
            ],
            "type": "string",
            "description": "How to scope the search. PublicSurplus filters server-side, so only matching auctions are fetched. 'all' pulls every active posting.",
            "default": "state"
          },
          "states": {
            "title": "States / regions",
            "type": "array",
            "description": "Two-letter state (region) codes, e.g. tx, ca, ny. Used when Search type = By state.",
            "items": {
              "type": "string"
            }
          },
          "categoryId": {
            "title": "Category ID",
            "type": "string",
            "description": "PublicSurplus category id (catId), e.g. 403 = Auto. Used when Search type = By category. Find ids by browsing a category on the site."
          },
          "keyword": {
            "title": "Keyword",
            "type": "string",
            "description": "Free-text keyword (keyWord) matched against auction titles/descriptions."
          },
          "zipcode": {
            "title": "ZIP code",
            "type": "string",
            "description": "ZIP code center when Search type = By ZIP + radius. Pair with the radius below."
          },
          "radiusMiles": {
            "title": "Radius (miles)",
            "type": "integer",
            "description": "Search radius around the ZIP (milesLocation). Common values: 25, 50, 100, 200, 500.",
            "default": 100
          },
          "priceMin": {
            "title": "Min price ($)",
            "minimum": 0,
            "type": "integer",
            "description": "Only return auctions with a current price at/above this (lowerPrice). Leave empty for no floor."
          },
          "priceMax": {
            "title": "Max price ($)",
            "minimum": 0,
            "type": "integer",
            "description": "Only return auctions with a current price at/below this (higherPrice) — bargain filter. Leave empty for no cap."
          },
          "endWithinHours": {
            "title": "Ending within (hours)",
            "minimum": 0,
            "type": "integer",
            "description": "Only auctions ending within this many hours (endHours) — urgency / closing-soon filter. 0 = no limit.",
            "default": 0
          },
          "listedWithinHours": {
            "title": "Listed within (hours)",
            "minimum": 0,
            "type": "integer",
            "description": "Only auctions POSTED within this many hours (startHours). Server-side 'new lots' filter — pair with Monitor mode + a Schedule for cheap, fast recurring runs. 0 = no limit.",
            "default": 0
          },
          "sortBy": {
            "title": "Sort by",
            "enum": [
              "default",
              "newest",
              "ending",
              "price"
            ],
            "type": "string",
            "description": "Result ordering. 'newest' surfaces freshly listed lots first (good for monitors).",
            "default": "default"
          },
          "fetchDetails": {
            "title": "Fetch full details",
            "type": "boolean",
            "description": "Open each auction's detail page for full description, agency/seller, full address, bid count, increment, quantity, condition, and all photos. One extra request per lot.",
            "default": true
          },
          "maxLots": {
            "title": "Max lots per run",
            "minimum": 0,
            "type": "integer",
            "description": "Hard cap on auctions scraped this run (cost/safety guard). 0 = unlimited.",
            "default": 0
          },
          "monitorMode": {
            "title": "Monitor mode (new-lot watcher)",
            "type": "boolean",
            "description": "Recurring watcher: diff against the prior run's seen lots (per scope) and output/alert ONLY newly-listed lots. Pair with an Apify Schedule. Tip: also set 'Listed within' to narrow server-side.",
            "default": false
          },
          "alertOnNewLot": {
            "title": "Alert on new lots",
            "type": "boolean",
            "description": "In monitor mode, deliver an alert for each newly-listed lot via the channels below.",
            "default": true
          },
          "alertOnBidChange": {
            "title": "Alert on bid/price changes (watchlist)",
            "type": "boolean",
            "description": "Also alert when the current price changes on a watched auction (see watchlist IDs).",
            "default": false
          },
          "watchlistAuctionIds": {
            "title": "Watchlist auction IDs",
            "type": "array",
            "description": "Specific auction ids to track for price changes when 'Alert on bid/price changes' is on.",
            "items": {
              "type": "string"
            }
          },
          "webhookUrl": {
            "title": "Webhook URL",
            "type": "string",
            "description": "POST endpoint for new-lot alert payloads (Make / Zapier / n8n / custom). One JSON body per alert."
          },
          "slackWebhookUrl": {
            "title": "Slack webhook URL",
            "type": "string",
            "description": "Slack incoming-webhook URL for formatted new-lot cards."
          },
          "emailRecipients": {
            "title": "Email recipients",
            "type": "array",
            "description": "Email addresses for the new-lot digest (sent via apify/send-mail).",
            "items": {
              "type": "string"
            }
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Proxy settings. Datacenter rotation is enough for this site.",
            "default": {
              "useApifyProxy": true
            }
          },
          "requestConcurrency": {
            "title": "Request concurrency",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "Max parallel requests for page and detail fetches. Keep modest to respect the site's rate limits.",
            "default": 5
          },
          "diagnose": {
            "title": "Diagnostic mode (dev)",
            "type": "boolean",
            "description": "Dev only. Dumps the raw search + detail HTML to the key-value store (DEBUG_SEARCH_HTML / DEBUG_DETAIL_HTML) and logs the parsed first row + pagination check, then exits. Use to verify selectors; leave off for normal runs.",
            "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
                  }
                }
              },
              "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}