{ "openapi": "3.0.1", "info": { "title": "GSA Auctions Scraper & Surplus Monitor", "description": "Scrape GSA Auctions (gsaauctions.gov) federal surplus listings by state, keyword, agency, or ZIP, or run on a schedule as a new-lot monitor with Slack/email/webhook alerts.", "version": "0.1", "x-build-id": "4uH3muxFcVLtJCBIM" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapersdelight~gsa-auctions-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapersdelight-gsa-auctions-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~gsa-auctions-scraper/runs": { "post": { "operationId": "runs-sync-scrapersdelight-gsa-auctions-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~gsa-auctions-scraper/run-sync": { "post": { "operationId": "run-sync-scrapersdelight-gsa-auctions-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", "keyword", "agency", "zipcode", "all" ], "type": "string", "description": "How to scope the feed. GSA publishes one national active-auctions feed, so scoping is applied to the downloaded feed. 'all' returns every active lot.", "default": "state" }, "states": { "title": "States", "type": "array", "description": "Two-letter property-state codes, e.g. tx, ca, va. Used when Search type = By state.", "items": { "type": "string" } }, "keyword": { "title": "Keyword", "type": "string", "description": "Free-text keyword matched against the lot title + description (e.g. 'truck', 'laptop', 'tractor')." }, "agency": { "title": "Agency", "type": "string", "description": "Filter by selling agency / bureau name (substring match), e.g. 'NASA', 'Army', 'Forest Service'." }, "zipcodes": { "title": "ZIP codes", "type": "array", "description": "Property ZIP codes (exact match) when Search type = By ZIP.", "items": { "type": "string" } }, "status": { "title": "Auction status", "enum": [ "active", "preview", "all" ], "type": "string", "description": "Filter by status within the feed. 'active' = biddable now; 'preview' = not yet open.", "default": "active" }, "maxBid": { "title": "Max current bid ($)", "minimum": 0, "type": "integer", "description": "Only return lots whose current high bid is at or below this (bargain filter). Lots with no bids yet are always included. Leave empty for no cap." }, "maxLots": { "title": "Max lots per run", "minimum": 0, "type": "integer", "description": "Hard cap on lots returned this run (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.", "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 changes (watchlist)", "type": "boolean", "description": "Also alert when the high bid changes on a watched lot (see watchlist IDs).", "default": false }, "watchlistLotIds": { "title": "Watchlist lot IDs", "type": "array", "description": "Specific lot ids (saleNo-lotNo) to track for bid changes when 'Alert on bid changes' is on.", "items": { "type": "string" } }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "POST endpoint for new-lot alert payloads (Make / Zapier / n8n / custom)." }, "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" } }, "apiKey": { "title": "api.data.gov API key", "type": "string", "description": "GSA's feed is served via api.gsa.gov. 'DEMO_KEY' works out of the box but is rate-limited; for heavy use get a free key at api.data.gov and paste it here.", "default": "DEMO_KEY" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Proxy settings. Optional for this public API; datacenter is plenty.", "default": { "useApifyProxy": true } }, "diagnose": { "title": "Diagnostic mode (dev)", "type": "boolean", "description": "Dev only. Dumps the raw feed record shape to the log + key-value store (DEBUG_RAW_FEED), then exits. Use to verify field mappings; 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 } } } } } } } } } }