{
  "openapi": "3.0.1",
  "info": {
    "title": "Ritchie Bros Scraper - Sold Prices, Auction Lots & Serials",
    "description": "Scrape rbauction.com: Ritchie Bros. auction results with hammer prices, live and upcoming lots. Make, model, year, serial/VIN, hours, lot number, auction, sold date, location. Filter by category, make, year, hours, state, sold-date window. Optional lot pages: photos, inspection, yard address.",
    "version": "0.1",
    "x-build-id": "Ei3L1dlM9WLLv8DJC"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/scrapersdelight~rbauction-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-scrapersdelight-rbauction-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~rbauction-scraper/runs": {
      "post": {
        "operationId": "runs-sync-scrapersdelight-rbauction-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~rbauction-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-scrapersdelight-rbauction-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": {
          "listingStatuses": {
            "title": "Listing status",
            "type": "array",
            "description": "Sold = past auction results with the sale price. Open / New / Preview = lots for sale now or coming up. Pick one or more.",
            "items": {
              "type": "string",
              "enum": [
                "Sold",
                "Open",
                "New",
                "Preview"
              ],
              "enumTitles": [
                "Sold (past results with prices)",
                "Open (bidding now)",
                "New (catalogued for an upcoming auction)",
                "Preview (viewing before bidding opens)"
              ]
            },
            "default": [
              "Sold"
            ]
          },
          "searchQueries": {
            "title": "Search keywords",
            "type": "array",
            "description": "Free text as you would type it in the rbauction.com search box, one search per line, e.g. \"cat 320\", \"dump truck\", \"john deere 8r\". Each line is its own search; the filters below apply to every line.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "rbauction.com URLs or item numbers",
            "type": "array",
            "description": "Paste category or search URLs (https://www.rbauction.com/cp/excavators?listingStatuses=Sold, https://www.rbauction.com/search?freeText=...), lot URLs (/pdp/...) or bare item numbers (15734241). A URL keeps exactly the filters it carries.",
            "items": {
              "type": "string"
            }
          },
          "industries": {
            "title": "Industries",
            "type": "array",
            "description": "The site's 14 top-level industries. Leave empty for all. Ignored when Categories are set (categories are narrower).",
            "items": {
              "type": "string",
              "enum": [
                "construction",
                "trucks-trailers",
                "agriculture",
                "consumer-items",
                "motors",
                "forklifts-and-warehouse-equipment",
                "oil-gas",
                "cranes",
                "government-surplus",
                "quarry-aggregate",
                "forestry",
                "aircraft",
                "mining",
                "real-estate"
              ],
              "enumTitles": [
                "Construction",
                "Trucks & Trailers",
                "Agriculture",
                "Consumer Items",
                "Motors",
                "Forklifts and Warehouse Equipment",
                "Oil & Gas",
                "Cranes",
                "Government Surplus",
                "Quarry & Aggregate",
                "Forestry",
                "Aircraft",
                "Mining",
                "Real Estate"
              ]
            }
          },
          "categories": {
            "title": "Categories / equipment types",
            "type": "array",
            "description": "rbauction.com category or equipment-type slugs - the part after /cp/ in a category URL, e.g. excavators, wheel-loaders, truck-tractors, mini-excavator-6-6t, skid-steer-loaders.",
            "items": {
              "type": "string"
            }
          },
          "manufacturers": {
            "title": "Makes",
            "type": "array",
            "description": "Manufacturer names as the site spells them, e.g. Cat, John Deere, Komatsu, Freightliner, Kubota. Leave empty for every make.",
            "items": {
              "type": "string"
            }
          },
          "models": {
            "title": "Models",
            "type": "array",
            "description": "Model names as the site spells them, e.g. 320, D6T, 8R 370. Works best together with Makes.",
            "items": {
              "type": "string"
            }
          },
          "yearMin": {
            "title": "Year from",
            "minimum": 1900,
            "maximum": 2100,
            "type": "integer",
            "description": "Oldest model year to include, e.g. 2015."
          },
          "yearMax": {
            "title": "Year to",
            "minimum": 1900,
            "maximum": 2100,
            "type": "integer",
            "description": "Newest model year to include, e.g. 2022."
          },
          "hoursMin": {
            "title": "Hours from",
            "minimum": 0,
            "type": "integer",
            "description": "Minimum hour-meter reading. Lots without an hour reading are left out when this is set."
          },
          "hoursMax": {
            "title": "Hours to",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum hour-meter reading, e.g. 5000."
          },
          "kilometersMin": {
            "title": "Odometer from (km)",
            "minimum": 0,
            "type": "integer",
            "description": "Minimum odometer reading in kilometres (trucks and vehicles; miles readings are converted by the site)."
          },
          "kilometersMax": {
            "title": "Odometer to (km)",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum odometer reading in kilometres, e.g. 300000."
          },
          "countries": {
            "title": "Countries / regions",
            "type": "array",
            "description": "Where the equipment is located (the site's top location level).",
            "items": {
              "type": "string",
              "enum": [
                "USA",
                "CAN",
                "EUR",
                "AUO",
                "MEX",
                "MID",
                "ASI",
                "CSA",
                "AFR"
              ],
              "enumTitles": [
                "United States",
                "Canada",
                "Europe",
                "Australia & New Zealand",
                "Mexico",
                "Middle East",
                "Asia",
                "South & Central America",
                "Africa"
              ]
            }
          },
          "regions": {
            "title": "Sub-regions",
            "type": "array",
            "description": "The site's second location level: US-SOU, US-WES, US-MDW, US-NRE, CA-PRA, CA-CEN, CA-WEC, CA-MAR, or a European country code (GBR, NLD, FRA, DEU, ESP, ITA, POL, SWE, IRL...), AUS, NZL.",
            "items": {
              "type": "string"
            }
          },
          "states": {
            "title": "States / provinces",
            "type": "array",
            "description": "The site's state codes: US-TX, US-CA, US-FL, CA-AB, CA-ON, AU-QLD and so on.",
            "items": {
              "type": "string"
            }
          },
          "platforms": {
            "title": "RB Global platforms",
            "type": "array",
            "description": "Which RB Global marketplace the lot sells on. Live IronPlanet and Marketplace-E lots are never returned (our IronPlanet Scraper covers them); their sold results are.",
            "items": {
              "type": "string",
              "enum": [
                "Ritchie Bros. Auctioneers",
                "GovPlanet",
                "TruckPlanet",
                "SalvageSale",
                "IronPlanet",
                "Marketplace-E"
              ],
              "enumTitles": [
                "Ritchie Bros. Auctioneers",
                "GovPlanet",
                "TruckPlanet",
                "SalvageSale",
                "IronPlanet (sold results only)",
                "Marketplace-E (sold results only)"
              ]
            }
          },
          "ironCladOnly": {
            "title": "IronClad Assurance only",
            "type": "boolean",
            "description": "Only lots carrying the IronClad Assurance inspection guarantee.",
            "default": false
          },
          "unusedOnly": {
            "title": "Unused only",
            "type": "boolean",
            "description": "Only lots the site marks as unused (new).",
            "default": false
          },
          "withPhotosOnly": {
            "title": "With photos only",
            "type": "boolean",
            "description": "Only lots that have at least one photo.",
            "default": false
          },
          "soldFrom": {
            "title": "Sold from",
            "type": "string",
            "description": "Sold results only: first sale date to include, YYYY-MM-DD (UTC). Leave empty for the whole archive."
          },
          "soldTo": {
            "title": "Sold to",
            "type": "string",
            "description": "Sold results only: last sale date to include, YYYY-MM-DD (UTC), inclusive. Leave empty for today."
          },
          "soldWithinDays": {
            "title": "Sold in the last N days",
            "minimum": 0,
            "maximum": 3650,
            "type": "integer",
            "description": "Sold results only: shortcut for a rolling window, e.g. 7 or 30. Pairs well with a daily or weekly schedule. 0 = no limit."
          },
          "buyingFormats": {
            "title": "Buying formats",
            "type": "array",
            "description": "Keep only these sale formats (checked on each lot after it is read). Ritchie Bros. regional auctions are Live Auction; IronPlanet, GovPlanet and TruckPlanet are Online Auction; SalvageSale is Sealed Bid.",
            "items": {
              "type": "string",
              "enum": [
                "Live Auction",
                "Online Auction",
                "Make Offer",
                "Sealed Bid",
                "Buy Now"
              ],
              "enumTitles": [
                "Live Auction",
                "Online Auction",
                "Make Offer",
                "Sealed Bid",
                "Buy Now"
              ]
            }
          },
          "priceMin": {
            "title": "Price from",
            "minimum": 0,
            "type": "integer",
            "description": "Minimum of the row's price field, in the lot's own currency: the sale price for sold lots, the starting bid or asking price for live lots. Sold online-auction lots only carry a price with Lot page details on."
          },
          "priceMax": {
            "title": "Price to",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum of the row's price field, in the lot's own currency."
          },
          "includeDetails": {
            "title": "Lot page details",
            "type": "boolean",
            "description": "Open each lot's page for: the sold price of online, sealed-bid and GovPlanet/TruckPlanet lots (local currency and USD), the full photo gallery, the inspection rating and report, the yard street address and postal code, the bid increment. Slower; same price per lot.",
            "default": false
          },
          "monitorMode": {
            "title": "Only new or changed lots",
            "type": "boolean",
            "description": "Remember the lots this search delivered before (in a named key-value store) and deliver only new lots, plus live lots whose status or price changed (changeType says which). With Lot page details on, a lot delivered earlier without them comes back once as details. Pairs well with a daily schedule.",
            "default": false
          },
          "monitorStoreName": {
            "title": "Monitor store name",
            "type": "string",
            "description": "Name of the key-value store that holds the memory. Use a different name per watch list. Default: rbauction-monitor."
          },
          "maxItems": {
            "title": "Max lots",
            "minimum": 0,
            "type": "integer",
            "description": "Stop after this many lots. You are charged per delivered lot. 0 = everything the search lists (the whole sold archive is about 3.6 million lots).",
            "default": 100
          },
          "sort": {
            "title": "Order",
            "enum": [
              "auto",
              "endDesc",
              "endAsc"
            ],
            "type": "string",
            "description": "Lot order. Automatic = most recently sold first for sold results, closing soonest first for live lots. Only bidding-end-time orders are offered: the site's other orders reshuffle between pages.",
            "default": "auto"
          },
          "countOnly": {
            "title": "Count only",
            "type": "boolean",
            "description": "Return how many lots each search lists (in the run's status and RUN_SUMMARY) without delivering or charging any lot.",
            "default": false
          },
          "detailConcurrency": {
            "title": "Lot pages in parallel",
            "minimum": 1,
            "maximum": 12,
            "type": "integer",
            "description": "How many lot pages to open at once when Lot page details is on.",
            "default": 6
          },
          "useUnblocker": {
            "title": "Allow Apify Unblocker as a last resort",
            "type": "boolean",
            "description": "If direct requests and the residential proxy are both refused, fetch the site's own search and lot pages through Apify's Unblocker, under a per-run budget.",
            "default": true
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Not needed: rbauction.com answers direct requests. When direct requests are refused the run moves on to a US residential proxy by itself, under a per-run budget. Set your own proxy here to use it first.",
            "default": {
              "useApifyProxy": 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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}