{
  "openapi": "3.0.1",
  "info": {
    "title": "Ritchie Bros. Scraper — Global Auction Equipment​‌​",
    "description": "Mine Ritchie Bros. live and closed auctions for high-value commercial intelligence: sold prices, open lots and date-filtered inventory. Generate dealer and end-buyer leads, benchmark resale values and time outreach to active market windows.",
    "version": "0.8",
    "x-build-id": "N1UmCIy5QIX3AO40j"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/rastriq~rbauction-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-rastriq-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/rastriq~rbauction-scraper/runs": {
      "post": {
        "operationId": "runs-sync-rastriq-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/rastriq~rbauction-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-rastriq-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": {
          "inputMode": {
            "title": "Scraping mode",
            "enum": [
              "slugs",
              "urls",
              "discover"
            ],
            "type": "string",
            "description": "Choose how to define which categories to scrape:<br><ul><li><b>Category selection</b> — the list below is pre-filled with all known categories; delete the ones you don't want (recommended)</li><li><b>Category URLs</b> — paste full <code>https://www.rbauction.com/cp/…</code> URLs</li><li><b>Discover</b> — the actor crawls seed pages and collects all <code>/cp/</code> links automatically</li></ul>",
            "default": "slugs"
          },
          "categorySlugs": {
            "title": "Categories to scrape",
            "type": "string",
            "description": "One slug per line (the part after /cp/ in the URL). Leave empty to scrape ALL 35 known categories. Delete lines you don't need, or add new slugs manually."
          },
          "categoryUrls": {
            "title": "Category URLs",
            "type": "array",
            "description": "Full RBAuction category URLs, one per line. Each must contain <code>/cp/</code>. You can embed filters in the URL (e.g. <code>?listingStatuses=Sold</code>). Use this for any category not covered by the list above.",
            "items": {
              "type": "string"
            }
          },
          "discoverSeeds": {
            "title": "Catalog seeds",
            "type": "string",
            "description": "One URL per line. The actor fetches each seed page, collects all <code>/cp/{slug}</code> links found, and scrapes them. This list is fully editable."
          },
          "includeSeedCategories": {
            "title": "Include seed pages as categories",
            "type": "boolean",
            "description": "When discovering, also scrape the seed pages themselves — not just the categories linked from them.",
            "default": true
          },
          "maxDiscoveredCategories": {
            "title": "Max categories to discover",
            "minimum": 0,
            "maximum": 500,
            "type": "integer",
            "description": "Limit how many <code>/cp/</code> categories are discovered from seeds. Set to <code>0</code> for unlimited.",
            "default": 50
          },
          "storeCategoryInventory": {
            "title": "Save category inventory",
            "type": "boolean",
            "description": "Save a log of all <code>/cp/</code> slugs found during this run to the key-value store (key: <code>CATEGORY_INVENTORY</code>). Each entry includes: slug, URL, anchor text, parent seed, first seen timestamp.",
            "default": false
          },
          "listing_statuses": {
            "title": "Listing status",
            "enum": [
              "",
              "Sold",
              "Open"
            ],
            "type": "string",
            "description": "Filter listings by auction status. Overrides any <code>listingStatuses</code> parameter already in the URL. Leave empty to keep each URL's own filter.",
            "default": "Sold"
          },
          "date_from": {
            "title": "Auction date from",
            "type": "string",
            "description": "Only include listings whose auction ended <b>on or after</b> this date. Accepts <code>YYYY-MM-DD</code> or relative values like <code>30 days</code> or <code>3 months</code>. Leave empty for no lower bound."
          },
          "date_to": {
            "title": "Auction date to",
            "type": "string",
            "description": "Only include listings whose auction ended <b>on or before</b> this date. Accepts <code>YYYY-MM-DD</code> or relative values. Leave empty for no upper bound."
          },
          "manufacturers": {
            "title": "Make / Manufacturer filter",
            "type": "array",
            "description": "Filter by manufacturer name. Passed as <code>?manufacturers=</code> in the page URL. Examples: <code>Caterpillar</code>, <code>Komatsu</code>, <code>John Deere</code>. Leave empty for all brands.",
            "items": {
              "type": "string"
            }
          },
          "freeText": {
            "title": "Keyword search",
            "type": "string",
            "description": "Free-text keyword filter. Passed as <code>?freeText=</code>. Useful for filtering by location name, model suffix, or any term visible in listings. Example: <code>Nisku</code>, <code>D6T</code>."
          },
          "saleEventIDs": {
            "title": "Sale event ID filter",
            "type": "array",
            "description": "Limit results to specific sale events by their UUID. Passed as <code>?saleEventIDs=</code>. Find event IDs in the URL when browsing a sale on rbauction.com.",
            "items": {
              "type": "string"
            }
          },
          "sortBy": {
            "title": "Sort order",
            "enum": [
              "",
              "newest",
              "oldest",
              "priceAsc",
              "priceDesc"
            ],
            "type": "string",
            "description": "Sort order for listing results within each category page. Passed as <code>?sortBy=</code>.",
            "default": ""
          },
          "max_items": {
            "title": "Max items",
            "minimum": 1,
            "maximum": 100000,
            "type": "integer",
            "description": "Maximum total listings to extract across all categories. Each RBAuction page returns up to 60 items. The actor stops as soon as this limit is reached.",
            "default": 500
          },
          "maxPagesPerCategory": {
            "title": "Max pages per category",
            "minimum": 0,
            "maximum": 1000,
            "type": "integer",
            "description": "Maximum number of pages (60 items each) to scrape per category. Set to <code>0</code> for unlimited depth.",
            "default": 0
          },
          "startOffset": {
            "title": "Start offset",
            "minimum": 0,
            "type": "integer",
            "description": "Number of items to skip at the start of each category. Use to resume a partial run. Must be a multiple of 60 (e.g. 0, 60, 120, 180…).",
            "default": 0
          },
          "stopWhenNoNewAssets": {
            "title": "Stop when no new items found",
            "type": "boolean",
            "description": "Stop paginating a category when a full page returns zero new (unseen) items. Recommended when revisiting partially-scraped categories.",
            "default": true
          },
          "delaySeconds": {
            "title": "Delay between requests (seconds)",
            "minimum": 0.5,
            "maximum": 15,
            "type": "number",
            "description": "Base delay between page requests. Actual delay is randomised ±30% around this value. Increase to reduce load on the server.",
            "default": 1.5
          },
          "cookies": {
            "title": "Session cookies (JSON)",
            "type": "string",
            "description": "Paste your rbauction.com session cookies as a JSON array. <b>Required to unlock sold prices and GraphQL enrichment.</b><br><br>How to export:<ol><li>Install <a href='https://chromewebstore.google.com/detail/cookie-editor/hlkenndednhfkekhgcdicdfddnkalmdm' target='_blank'>Cookie-Editor</a> in Chrome</li><li>Log in to rbauction.com</li><li>Click the extension → <b>Export (JSON)</b></li><li>Paste the result here</li></ol>"
          },
          "enrich_graphql": {
            "title": "Enrich with GraphQL data",
            "type": "boolean",
            "description": "When enabled and cookies are provided, each item is enriched via RBAuction's internal API: confirmed hammer price, reserve price, bid count, currency, and exact sold timestamp. Adds ~0.5 s per item.",
            "default": true
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}