{ "openapi": "3.0.1", "info": { "title": "Ritchie Bros Auctioneers Scraper", "description": "Scrapes Ritchie Bros auction listings by keyword and filters. Returns equipment details like manufacturer, model, year, and location in a flat row.", "version": "1.0", "x-build-id": "WbNwSOg3ZoDNnxbTd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~ritchie-bros-auctioneers-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-ritchie-bros-auctioneers-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/parseforge~ritchie-bros-auctioneers-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-ritchie-bros-auctioneers-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/parseforge~ritchie-bros-auctioneers-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-ritchie-bros-auctioneers-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": { "searchQuery": { "title": "Equipment or keyword", "type": "string", "description": "Keyword search for equipment. Use '*' to return all listings. Examples: 'excavator', 'caterpillar 320', 'dump truck'." }, "maxItems": { "title": "Maximum listings", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "How many auction listings to collect per run." }, "searchType": { "title": "Search Type", "enum": [ "upcomingAuction" ], "type": "string", "description": "Currently only upcoming auctions are exposed. Past sold lots are not searchable via this endpoint.", "default": "upcomingAuction" }, "industry": { "title": "Industry", "enum": [ "", "380FB0EC-CB7C-3BEA-9FDA-11A46A5176AC", "38397D59-BE2B-3A1B-9C7E-32DA48C1BCCE", "EBE7DB97-F10C-33C2-98FA-789F4B4C94FC", "67FFEC94-F445-32E1-B437-A854F8CCADCA", "45AFC681-DF36-3EA8-8056-AAD0F272CE7B", "1708CF51-0351-3AAB-A1A5-8BB442DBF1DD" ], "type": "string", "description": "Filter by industry. Use industry UUID from the site or leave blank for all industries.", "default": "" }, "manufacturer": { "title": "Manufacturer", "type": "string", "description": "Filter by equipment manufacturer name. Example: 'Caterpillar', 'Komatsu', 'John Deere'." }, "manufactureYearMin": { "title": "Manufacture Year (Min)", "minimum": 1900, "maximum": 2030, "type": "integer", "description": "Minimum manufacture year filter. Example: 2015." }, "manufactureYearMax": { "title": "Manufacture Year (Max)", "minimum": 1900, "maximum": 2030, "type": "integer", "description": "Maximum manufacture year filter. Example: 2023." }, "locationCountry": { "title": "Location Country", "type": "string", "description": "Filter by country where equipment is located. Use country code. Example: 'US', 'CA', 'AU'." }, "maxConcurrency": { "title": "Max Concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum number of parallel page requests. Lower this if you get rate-limited.", "default": 5 }, "includeLotDetails": { "title": "📸 Include lot details", "type": "boolean", "description": "Adds the full photo gallery of each lot (up to 11 full-size photos), the street address and postal code of the yard where the machine sits, the odometer or hour meter reading with its unit, GVWR, fuel type, title information (titled asset, number of titles, MSO, title state), the seller-is-dealer flag, FET and duty-free flags and the export control number. One extra request per 60 lots. Charged only for a row that receives it.", "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 } } } } } } } } } }