{
  "openapi": "3.0.1",
  "info": {
    "title": "GovDeals Scraper — Surplus Auctions, Bids, VINs & Photos",
    "description": "Scrape GovDeals government surplus auctions by keyword, category, state or URL. Current bids, bid counts, close times, location, seller, VIN, condition, meter and full photo galleries. Monitor mode for new lots. $0.75/1K.",
    "version": "0.2",
    "x-build-id": "i8vmLVYch2U7OorVl"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/scrapelabmax~govdeals-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-scrapelabmax-govdeals-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/scrapelabmax~govdeals-scraper/runs": {
      "post": {
        "operationId": "runs-sync-scrapelabmax-govdeals-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/scrapelabmax~govdeals-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-scrapelabmax-govdeals-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": {
          "searchTerms": {
            "title": "Search terms",
            "type": "array",
            "description": "Keywords to search for, e.g. <code>truck</code>, <code>laptop</code>, <code>bucket truck</code>. Each term runs as its own search; results are de-duplicated across terms. Leave empty (with no start URLs) to browse every active lot.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "GovDeals URLs",
            "type": "array",
            "description": "Paste search, category or location pages from www.govdeals.com, e.g. <code>https://www.govdeals.com/en/search?kWord=truck</code>, <code>https://www.govdeals.com/en/bucket-trucks</code> or <code>https://www.govdeals.com/en/texas</code>. Keyword, category, state, ZIP + miles, price and sort in the URL are applied. You can also paste single lots, e.g. <code>https://www.govdeals.com/asset/10/29908</code> (AllSurplus lot URLs work too) to track exactly those lots. The filters below are applied on top.",
            "default": [],
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "categoryIds": {
            "title": "Categories",
            "type": "array",
            "description": "GovDeals category codes or category URL slugs, e.g. <code>644</code> or <code>bucket-trucks</code> (Bucket Trucks), <code>94C</code> or <code>trucks</code> (all trucks). Lots matching any listed category are returned.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "auctionStatus": {
            "title": "Auction status",
            "enum": [
              "active",
              "sold"
            ],
            "type": "string",
            "description": "<b>Active</b>: lots open for bidding now. <b>Sold</b>: lots that already closed (about the last 12 months GovDeals keeps), with the final price in <code>currentBid</code> — ideal for price research and comps. In sold mode the closing-time and new-listing filters do not apply.",
            "default": "active"
          },
          "soldWithinDays": {
            "title": "Sold within (days)",
            "minimum": 1,
            "maximum": 3650,
            "type": "integer",
            "description": "Sold mode only: lots that closed within this many days of the run start, e.g. <code>7</code> or <code>30</code>. Leave empty for everything GovDeals still shows (about 12 months)."
          },
          "saleTypes": {
            "title": "Sale types",
            "type": "array",
            "description": "Only lots sold this way. Leave empty for every sale type. Each selected type runs as its own search.",
            "items": {
              "type": "string",
              "enum": [
                "auction",
                "buyNow",
                "makeOffer",
                "sealedBid"
              ],
              "enumTitles": [
                "Online auction",
                "Buy Now (fixed price)",
                "Make Offer",
                "Sealed bid"
              ]
            },
            "default": []
          },
          "sellerAccountIds": {
            "title": "Seller account IDs",
            "type": "array",
            "description": "Only lots from these GovDeals sellers (agencies). The seller account ID is the last number in a lot URL: <code>https://www.govdeals.com/asset/10/<b>29908</b></code>. Leave empty for all sellers.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "states": {
            "title": "States / provinces",
            "type": "array",
            "description": "Only lots located in these US states or Canadian provinces. Leave empty for all locations.",
            "items": {
              "type": "string",
              "enum": [
                "AL",
                "AK",
                "AZ",
                "AR",
                "CA",
                "CO",
                "CT",
                "DE",
                "DC",
                "FL",
                "GA",
                "GU",
                "HI",
                "ID",
                "IL",
                "IN",
                "IA",
                "KS",
                "KY",
                "LA",
                "ME",
                "MD",
                "MA",
                "MI",
                "MN",
                "MS",
                "MO",
                "MT",
                "NE",
                "NV",
                "NH",
                "NJ",
                "NM",
                "NY",
                "NC",
                "ND",
                "OH",
                "OK",
                "OR",
                "PA",
                "PR",
                "RI",
                "SC",
                "SD",
                "TN",
                "TX",
                "UT",
                "VT",
                "VA",
                "WA",
                "WV",
                "WI",
                "WY",
                "AB",
                "BC",
                "MB",
                "NB",
                "NL",
                "NT",
                "NS",
                "NU",
                "ON",
                "PE",
                "QC",
                "SK",
                "YT"
              ],
              "enumTitles": [
                "Alabama",
                "Alaska",
                "Arizona",
                "Arkansas",
                "California",
                "Colorado",
                "Connecticut",
                "Delaware",
                "District of Columbia",
                "Florida",
                "Georgia",
                "Guam",
                "Hawaii",
                "Idaho",
                "Illinois",
                "Indiana",
                "Iowa",
                "Kansas",
                "Kentucky",
                "Louisiana",
                "Maine",
                "Maryland",
                "Massachusetts",
                "Michigan",
                "Minnesota",
                "Mississippi",
                "Missouri",
                "Montana",
                "Nebraska",
                "Nevada",
                "New Hampshire",
                "New Jersey",
                "New Mexico",
                "New York",
                "North Carolina",
                "North Dakota",
                "Ohio",
                "Oklahoma",
                "Oregon",
                "Pennsylvania",
                "Puerto Rico",
                "Rhode Island",
                "South Carolina",
                "South Dakota",
                "Tennessee",
                "Texas",
                "Utah",
                "Vermont",
                "Virginia",
                "Washington",
                "West Virginia",
                "Wisconsin",
                "Wyoming",
                "Alberta (Canada)",
                "British Columbia (Canada)",
                "Manitoba (Canada)",
                "New Brunswick (Canada)",
                "Newfoundland (Canada)",
                "Northwest Territories (Canada)",
                "Nova Scotia (Canada)",
                "Nunavut (Canada)",
                "Ontario (Canada)",
                "Prince Edward Island (Canada)",
                "Quebec (Canada)",
                "Saskatchewan (Canada)",
                "Yukon (Canada)"
              ]
            },
            "default": []
          },
          "zipCode": {
            "title": "ZIP / postal code",
            "type": "string",
            "description": "Only lots near this 5-digit US ZIP code or Canadian postal code (e.g. <code>77002</code>, <code>M5V 3L9</code>). Uses the radius below (50 miles if not set)."
          },
          "radiusMiles": {
            "title": "Radius (miles)",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "Search radius around the ZIP / postal code. Requires a ZIP / postal code."
          },
          "minPrice": {
            "title": "Minimum current price",
            "minimum": 0,
            "type": "integer",
            "description": "Only lots whose current bid / price (final price for sold lots) is at least this amount, in the lot’s currency. Lots without a price are excluded when a price filter is set."
          },
          "maxPrice": {
            "title": "Maximum current price",
            "minimum": 0,
            "type": "integer",
            "description": "Only lots whose current bid / price (final price for sold lots) is at most this amount, in the lot’s currency."
          },
          "endingWithinHours": {
            "title": "Closing within (hours)",
            "minimum": 1,
            "maximum": 720,
            "type": "integer",
            "description": "Active lots only: auctions that close within this many hours of the run start, e.g. <code>24</code> for lots closing today."
          },
          "newListingsOnly": {
            "title": "New listings only",
            "type": "boolean",
            "description": "Active lots only: lots GovDeals marks as newly listed.",
            "default": false
          },
          "sortBy": {
            "title": "Sort results by",
            "enum": [
              "relevance",
              "endingSoon",
              "newlyListed",
              "priceLowToHigh",
              "priceHighToLow"
            ],
            "type": "string",
            "description": "Order in which lots are collected — matters when <b>Max lots</b> cuts the list short. For sold lots, <b>Best match</b> and <b>Closing soonest</b> both mean most recently closed first, and the price sorts use the final price.",
            "default": "relevance"
          },
          "maxItems": {
            "title": "Max lots",
            "minimum": 1,
            "maximum": 100000,
            "type": "integer",
            "description": "Stop after this many lots in total across all searches. You are only charged for lots returned.",
            "default": 100
          },
          "includeDetails": {
            "title": "Include lot details",
            "type": "boolean",
            "description": "Also open each lot to add VIN / serial, condition, meter reading, quantity, full photo gallery, shipping and removal instructions, and title restrictions. Slower and billed as an extra per-lot event.",
            "default": false
          },
          "includeSellerContact": {
            "title": "Include seller contact",
            "type": "boolean",
            "description": "Add the seller’s point of contact (name, email, phone) when GovDeals shows it publicly on the lot page. Requires <b>Include lot details</b>.",
            "default": false
          },
          "onlyNewSinceLastRun": {
            "title": "Only lots not seen in previous runs",
            "type": "boolean",
            "description": "Monitoring mode: skip lots this Actor (or this saved task) already returned in an earlier run. Ideal for scheduled runs that alert on new inventory.",
            "default": false
          },
          "alertOnBidChange": {
            "title": "Also return lots whose bid changed",
            "type": "boolean",
            "description": "Monitoring mode add-on: also return lots seen in an earlier run whose current bid has changed since, with the previous bid in <code>previousBid</code>. Requires <b>Only lots not seen in previous runs</b>.",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}