{ "openapi": "3.0.1", "info": { "title": "AuctionZip Auctioneer Directory Scraper — Leads + Auctions", "description": "Scrape the AuctionZip auctioneer directory into US auction-house leads: company, contact name, street address, city/state/ZIP, phone, email, website, bio — plus each auctioneer's upcoming auction calendar (title, date, town, listing URL). Filter by state. No login.", "version": "0.1", "x-build-id": "dDTHf2FjAQZhTGlGX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapersdelight~auctionzip-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapersdelight-auctionzip-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~auctionzip-scraper/runs": { "post": { "operationId": "runs-sync-scrapersdelight-auctionzip-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~auctionzip-scraper/run-sync": { "post": { "operationId": "run-sync-scrapersdelight-auctionzip-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": [ "proxyConfiguration" ], "properties": { "states": { "title": "States (USPS codes)", "type": "array", "description": "Only return auctioneers based in these US states, e.g. OH, PA, TX. Leave empty for every state. The three biggest on AuctionZip are OH (598 auctioneers), PA (587) and IN (391).", "default": [], "items": { "type": "string" } }, "onlyWithUpcomingAuctions": { "title": "Only auctioneers with an upcoming auction", "type": "boolean", "description": "Skip auctioneers whose auction calendar is currently empty. 1,893 of the 5,013 listed auctioneers (37.8%) have at least one live auction. Turn this off to pull the whole directory as a plain lead list.", "default": true }, "maxAuctioneers": { "title": "Max auctioneers", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after this many auctioneer rows. You are charged per row returned, so this is also your budget control. The whole directory is 5,013 auctioneers.", "default": 100 }, "includeAuctionDetails": { "title": "Fetch auction venue address + category", "type": "boolean", "description": "Open each upcoming auction's own listing page to add the auction VENUE address (where the sale actually happens, which differs from the auctioneer's office) and the auctioneer's state licence number. Costs one extra page fetch per auction, so the run is slower — it does NOT change what you are charged, you still pay per auctioneer row.", "default": false }, "letters": { "title": "Directory index pages", "type": "array", "description": "Advanced. Which A-Z index pages of the auctioneer directory to sweep (auctioneers are indexed by surname initial; '1' holds the numeric names). Leave empty to sweep all of them.", "default": [], "items": { "type": "string" } }, "profileUrls": { "title": "Specific auctioneer profile URLs", "type": "array", "description": "Advanced. Scrape only these auctioneer profile URLs, e.g. https://www.auctionzip.com/PA-Auctioneers/6686.html. When set, the directory sweep and all filters above are skipped.", "default": [], "items": { "type": "string" } }, "requestConcurrency": { "title": "Request concurrency", "minimum": 1, "maximum": 8, "type": "integer", "description": "Parallel page fetches. AuctionZip runs an AWS WAF rate rule that allows about 6 requests per IP, which this Actor handles by rotating its proxy session every 4 requests. Lower this to 2 if you still see challenges in the log.", "default": 4 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "AuctionZip sits behind CloudFront + an AWS WAF rate rule that allows about 6 requests per IP, so a proxy is required. The shipped default — Apify RESIDENTIAL, country US — measured 40/40 requests with zero challenges. Apify datacenter also works because the Actor rotates its proxy session every 4 requests, but its smaller IP pool gets ~15% of sessions burned and retried; the Actor escalates itself to residential if that keeps happening.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }