{ "openapi": "3.0.1", "info": { "title": "Student Com Housing Scraper", "description": "Get every Student.com housing listing: price, floorplans, room types, real reviews, contact email and phone, office hours, and distance to university. Filter by state, city, university, price and rating, or look up a property by URL. No API key.", "version": "1.0", "x-build-id": "GdPyxmK5NftCjr0bZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/normdata~student-com-housing-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-normdata-student-com-housing-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/normdata~student-com-housing-scraper/runs": { "post": { "operationId": "runs-sync-normdata-student-com-housing-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/normdata~student-com-housing-scraper/run-sync": { "post": { "operationId": "run-sync-normdata-student-com-housing-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": { "maxItems": { "title": "Maximum results", "minimum": 1, "type": "integer", "description": "Caps how many properties this run writes. Starts at 10 for a quick sample; raise it for a full run." }, "mode": { "title": "What to do", "enum": [ "search", "lookup" ], "type": "string", "description": "Search filters the full property index. Look up resolves exact Student.com property URLs.", "default": "search" }, "state": { "title": "State(s) (for Search)", "type": "array", "description": "Two-letter US state code(s), e.g. TX, FL, CA. Leave empty for all states.", "items": { "type": "string" } }, "city": { "title": "City contains (for Search)", "type": "string", "description": "Match properties whose city contains this text, e.g. austin." }, "propertyName": { "title": "Property name contains (for Search)", "type": "string", "description": "Match properties whose name contains this text." }, "propertyType": { "title": "Property type (for Search)", "type": "array", "description": "Match one or more property types exactly as Student.com labels them, e.g. Apartment, House, PBSA. Leave empty for all types.", "items": { "type": "string" } }, "university": { "title": "University contains (for Search)", "type": "string", "description": "Match properties whose nearest university name or slug contains this text, e.g. \"University of Texas\"." }, "priceMin": { "title": "Minimum monthly price, USD (for Search)", "type": "integer", "description": "Only properties whose lowest listed monthly price is at least this." }, "priceMax": { "title": "Maximum monthly price, USD (for Search)", "type": "integer", "description": "Only properties whose lowest listed monthly price is at most this." }, "minRating": { "title": "Minimum review rating (for Search)", "type": "number", "description": "Only properties with an average rating at or above this (0-5)." }, "minReviewCount": { "title": "Minimum review count (for Search)", "type": "integer", "description": "Only properties with at least this many reviews on file." }, "wheelchairAccessibleOnly": { "title": "Wheelchair accessible only (for Search)", "type": "boolean", "description": "Only properties flagged wheelchair accessible.", "default": false }, "hasContactEmail": { "title": "Has a contact email (for Search)", "type": "boolean", "description": "Only properties with a direct contact email on file, useful for outreach lists.", "default": false }, "hasPhone": { "title": "Has a phone number (for Search)", "type": "boolean", "description": "Only properties with a phone number on file.", "default": false }, "urls": { "title": "Property URLs (for Look up)", "type": "array", "description": "Full Student.com property URLs, e.g. https://www.student.com/us/tx/austin/p/aria-grand-knpomm. An unresolved URL comes back as an error row.", "items": { "type": "string" } } } }, "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 } } } } } } } } } }