{
  "openapi": "3.0.1",
  "info": {
    "title": "College Recruit Rankings: On3 Cross-Source Ratings",
    "description": "Scrapes On3.com recruit rankings with On3, 247Sports, ESPN, and Rivals star ratings shown side by side per player, plus a computed rating-agreement-spread score. Filter by state, position, star tier, and committed school. Includes NIL valuations and incremental ranking-change monitoring.",
    "version": "0.1",
    "x-build-id": "hl3FYSsYoG1ggiTkd"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/getascraper~college-recruiting-rankings-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-getascraper-college-recruiting-rankings-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/getascraper~college-recruiting-rankings-scraper/runs": {
      "post": {
        "operationId": "runs-sync-getascraper-college-recruiting-rankings-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/getascraper~college-recruiting-rankings-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-getascraper-college-recruiting-rankings-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": {
          "classYear": {
            "title": "Recruiting class year",
            "minimum": 2020,
            "maximum": 2032,
            "type": "integer",
            "description": "The high school recruiting class to scrape (e.g. 2027 for the class currently being recruited). On3 publishes rankings for the active class plus several years ahead/behind.",
            "default": 2027
          },
          "maxPages": {
            "title": "Max ranking pages",
            "minimum": 1,
            "maximum": 48,
            "type": "integer",
            "description": "Upper bound on how many paginated On3 ranking pages (50 players/page) are fetched before stopping.",
            "default": 20
          },
          "states": {
            "title": "States",
            "type": "array",
            "description": "Only include recruits whose high school state matches one of the selected two-letter state codes. Leave empty to include all states.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "positions": {
            "title": "Positions",
            "type": "array",
            "description": "Only include recruits at one of the selected positions. Leave empty to include all positions.",
            "items": {
              "type": "string",
              "enum": [
                "QB",
                "RB",
                "FB",
                "WR",
                "TE",
                "OT",
                "OG",
                "OC",
                "IOL",
                "DL",
                "DE",
                "DT",
                "EDGE",
                "LB",
                "ILB",
                "OLB",
                "CB",
                "S",
                "ATH",
                "K",
                "P",
                "LS"
              ],
              "enumTitles": [
                "QB",
                "RB",
                "FB",
                "WR",
                "TE",
                "OT",
                "OG",
                "OC",
                "IOL",
                "DL",
                "DE",
                "DT",
                "EDGE",
                "LB",
                "ILB",
                "OLB",
                "CB",
                "S",
                "ATH",
                "K",
                "P",
                "LS"
              ]
            },
            "default": []
          },
          "minStars": {
            "title": "Minimum star rating",
            "minimum": 0,
            "maximum": 5,
            "type": "integer",
            "description": "Only include recruits rated at least this many stars (On3's own star tier). 0 disables this filter.",
            "default": 0
          },
          "committedSchool": {
            "title": "Committed school contains",
            "type": "string",
            "description": "Only include recruits whose committed program slug/name contains this text (e.g. \"ohio-state\", \"georgia\"). Case-insensitive. Leave blank to include all."
          },
          "uncommittedOnly": {
            "title": "Uncommitted only",
            "type": "boolean",
            "description": "Only include recruits who have not yet committed to a school.",
            "default": false
          },
          "minInterestCount": {
            "title": "Minimum recruiting interest count",
            "minimum": 0,
            "type": "integer",
            "description": "Only include recruits with at least this many programs shown as recruiting interest on On3 (On3's `interestCount` field). Note: this reflects On3's tracked recruiting interest, not a confirmed list of official scholarship offers -- no site in this Actor's scope publishes a distinct, verifiable offer list, so this field is not fabricated as one.",
            "default": 0
          },
          "includeSourceRatings": {
            "title": "Include cross-source rating breakdown",
            "type": "boolean",
            "description": "Include the per-vendor rating breakdown (On3, 247Sports, ESPN, Rivals, Consensus) and the computed rating-agreement spread for each recruit. This is the Actor's headline differentiator -- turn off only to shrink dataset size.",
            "default": true
          },
          "includeNilValuation": {
            "title": "Include NIL valuation",
            "type": "boolean",
            "description": "Include On3's NIL (Name, Image, Likeness) valuation estimate in USD, when published for that recruit.",
            "default": true
          },
          "maxItems": {
            "title": "Max items",
            "minimum": 1,
            "maximum": 5000,
            "type": "integer",
            "description": "Maximum number of recruit records to output.",
            "default": 50
          },
          "retries": {
            "title": "Retries per request",
            "minimum": 0,
            "maximum": 12,
            "type": "integer",
            "description": "Number of retry attempts for a failed page fetch before giving up. On3.com's anti-bot challenge only sometimes resolves per attempt, so a higher default than usual is used.",
            "default": 8
          },
          "onlyNewOrChanged": {
            "title": "Only new or changed rankings (monitoring mode)",
            "type": "boolean",
            "description": "Skip recruits whose national rank, star rating, and committed school are unchanged since the previous run under the same State key. Pair with a schedule to build a ranking-movement feed (new entrants, rating changes, commits/decommits).",
            "default": false
          },
          "resetSeenBaseline": {
            "title": "Reset seen-recruits baseline",
            "type": "boolean",
            "description": "Clear the stored baseline for this State key before this run, so the next run's onlyNewOrChanged comparison starts fresh.",
            "default": false
          },
          "stateKey": {
            "title": "State key",
            "type": "string",
            "description": "Namespace for the monitoring baseline, useful when running multiple watch configurations (e.g. per class year or per state) from the same Actor.",
            "default": "college-recruiting-default"
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "on3.com is protected by a genuine Cloudflare JS challenge (confirmed via direct testing: plain requests and both DATACENTER and RESIDENTIAL Apify proxy groups receive a 403 challenge page on every request). Only Apify's UNBLOCKER proxy group -- purpose-built to solve JS/anti-bot challenges, not just rotate IP reputation -- gets through. Do not switch this to RESIDENTIAL or DATACENTER; it will fail on the very first request.",
            "default": {
              "useApifyProxy": true,
              "apifyProxyGroups": [
                "UNBLOCKER"
              ]
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}