{ "openapi": "3.0.1", "info": { "title": "US Higher-Ed Intelligence — Rankings + Scorecard + IPEDS", "description": "One school, one row, three verified sources: US News grad rankings + College Scorecard + IPEDS, joined by IPEDS UNITID. Clean records + raw + run summary.", "version": "1.0", "x-build-id": "RAUYltDFruDglaiFm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/commanding_hotdog~us-higher-ed-intelligence/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-commanding_hotdog-us-higher-ed-intelligence", "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/commanding_hotdog~us-higher-ed-intelligence/runs": { "post": { "operationId": "runs-sync-commanding_hotdog-us-higher-ed-intelligence", "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/commanding_hotdog~us-higher-ed-intelligence/run-sync": { "post": { "operationId": "run-sync-commanding_hotdog-us-higher-ed-intelligence", "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": { "datasets": { "title": "Data sources", "type": "array", "description": "Which sources to collect: usnews_grad_rankings (US News graduate school rankings), scorecard (College Scorecard earnings/completion), ipeds (official IPEDS tables). Select any combination.", "default": [ "usnews_grad_rankings", "scorecard", "ipeds" ], "items": { "type": "string" } }, "gradCategories": { "title": "US News ranking categories", "type": "array", "description": "Graduate ranking categories to scrape (only used when usnews_grad_rankings is selected).", "default": [ "top-law-schools", "top-medical-schools", "top-business-schools", "top-engineering-schools", "top-nursing-schools", "top-education-schools", "top-computer-science-schools", "top-public-affairs-schools", "top-health-schools" ], "items": { "type": "string" } }, "ipedsTables": { "title": "IPEDS tables", "type": "array", "description": "IPEDS survey tables to load (only used when ipeds is selected). directory=HD institutions, tuition=IC annual charges, graduation=GR cohorts, salaries=instructional staff, enrollment=EF fall enrollment.", "default": [ "directory", "tuition", "graduation", "salaries", "enrollment" ], "items": { "type": "string" } }, "outputMode": { "title": "Output mode", "enum": [ "joined", "normalized", "raw", "summary" ], "type": "string", "description": "joined = one row per school merging all selected sources (recommended); normalized = one record per source per school; raw = raw records with light envelope; summary = run summary only.", "default": "joined" }, "maxResults": { "title": "Maximum results", "enum": [ "20", "50", "100", "200", "500", "1000", "2000", "5000", "10000" ], "type": "string", "description": "Maximum number of records to output in total (applied while loading, not at the end).", "default": "20" }, "stateFilter": { "title": "State filter", "type": "string", "description": "Two-letter US state code to filter schools (e.g. CA, NY). Leave empty for all states.", "default": "" }, "typeFilter": { "title": "Control filter", "enum": [ "", "public", "private" ], "type": "string", "description": "Filter by institutional control: public or private. Leave empty for both.", "default": "" }, "scorecardApiKey": { "title": "College Scorecard API key", "type": "string", "description": "Optional api.data.gov key for the Scorecard source. DEMO_KEY works for small runs (rate-limited); get a free key at api.data.gov for large pulls.", "default": "" } } }, "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 } } } } } } } } } }