{ "openapi": "3.0.1", "info": { "title": "IronPlanet Scraper — Heavy Equipment Auctions & Marketplace-E", "description": "Scrape IronPlanet and Marketplace-E heavy equipment listings: prices, make/model/year, hours, serials, GPS, IronClad Assurance, auction dates, and images. Filter by manufacturer, category, or keywords; monitor new inventory and price changes.", "version": "0.2", "x-build-id": "0lFsD8qC9OOBRHWXQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawloop~ironplanet-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawloop-ironplanet-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/crawloop~ironplanet-scraper/runs": { "post": { "operationId": "runs-sync-crawloop-ironplanet-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/crawloop~ironplanet-scraper/run-sync": { "post": { "operationId": "run-sync-crawloop-ironplanet-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": { "startUrls": { "title": "Start URLs", "type": "array", "description": "Optional RB / IronPlanet search or PDP URLs (e.g. https://www.rbauction.com/heavy-equipment?buyingPlatforms=IronPlanet or https://www.rbauction.com/pdp/14047362). Leave empty to build a search from filters.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "searchQuery": { "title": "Keywords (freeText)", "type": "string", "description": "Server-side free-text filter (e.g. Cat 320, excavator, skid steer)." }, "platforms": { "title": "Platforms", "type": "array", "description": "IronPlanet weekly auctions and/or Marketplace-E (Buy Now / Make Offer).", "items": { "type": "string", "enum": [ "IronPlanet", "Marketplace-E" ], "enumTitles": [ "IronPlanet", "Marketplace-E" ] }, "default": [ "IronPlanet" ] }, "listingMode": { "title": "Listing mode", "enum": [ "active", "sold" ], "type": "string", "description": "active = open / preview / buy-now pending. sold = completed results (public sold UI often limited for IronPlanet-only filters).", "default": "active" }, "manufacturer": { "title": "Manufacturer", "type": "string", "description": "Brand filter as shown on the marketplace (e.g. Cat, John Deere, Komatsu, Kubota, Volvo)." }, "categorySlug": { "title": "Category SEO slug", "type": "string", "description": "RB category path slug (e.g. excavator, excavators, wheel-loaders, mini-excavator-6-6t)." }, "country": { "title": "Country / region code", "type": "string", "description": "Optional location level filter (e.g. USA, CAN, EUR, ASI)." }, "buyingFormat": { "title": "Buying format", "type": "string", "description": "Optional format filter (Online Auction, Buy Now, Make Offer, Live Auction, Timed Auction, Sealed Bid)." }, "ironCladOnly": { "title": "IronClad Assurance only", "type": "boolean", "description": "Keep only listings with IronClad Assurance inspection certification.", "default": false }, "runMode": { "title": "Run mode", "enum": [ "listings", "details" ], "type": "string", "description": "listings = fast SSR card fields. details = also open each PDP for enrichment.", "default": "listings" }, "maxItems": { "title": "Max items", "minimum": 0, "type": "integer", "description": "Maximum listings to emit (0 = unlimited within max pages). In monitor seed runs this is the fingerprint budget.", "default": 100 }, "maxPages": { "title": "Max pages", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum SSR pages per crawl (~60 listings/page).", "default": 40 }, "concurrency": { "title": "Detail concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Parallel PDP fetches when runMode=details.", "default": 5 }, "monitorMode": { "title": "Monitor mode", "type": "boolean", "description": "Track new listings and price/status changes via a named Key-Value store. First run seeds fingerprints with no dataset rows.", "default": false }, "monitorStoreName": { "title": "Monitor store name", "type": "string", "description": "Apify Key-Value store name for fingerprints (use a distinct name per watch target).", "default": "ironplanet-monitor-state" }, "resetMonitorState": { "title": "Reset monitor state", "type": "boolean", "description": "Clear fingerprints before this run (forces a new seed).", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy. Residential recommended for reliability." } } }, "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 } } } } } } } } } }