{ "openapi": "3.0.1", "info": { "title": "HUD Multifamily Assisted Properties Scraper", "description": "Extract HUD-assisted multifamily properties, contracts, units, risk signals, locations, and management contacts from public HUD ArcGIS data.", "version": "0.1", "x-build-id": "HbORJnWFTItFlwsUm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automation-lab~hud-multifamily-assisted-properties-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automation-lab-hud-multifamily-assisted-properties-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/automation-lab~hud-multifamily-assisted-properties-scraper/runs": { "post": { "operationId": "runs-sync-automation-lab-hud-multifamily-assisted-properties-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/automation-lab~hud-multifamily-assisted-properties-scraper/run-sync": { "post": { "operationId": "run-sync-automation-lab-hud-multifamily-assisted-properties-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": { "states": { "title": "States", "type": "array", "description": "Two-letter state codes to include. Leave empty for nationwide results.", "items": { "type": "string" } }, "city": { "title": "City", "type": "string", "description": "Optional city filter, matched against HUD's standardized city field." }, "zipCodes": { "title": "ZIP codes", "type": "array", "description": "Optional five-digit ZIP codes to include.", "items": { "type": "string" } }, "propertyNameQuery": { "title": "Property name contains", "type": "string", "description": "Case-insensitive substring filter for HUD property names." }, "propertyCategories": { "title": "Property categories", "type": "array", "description": "Optional exact HUD property category names to include.", "items": { "type": "string" } }, "clientGroupNames": { "title": "Client group names", "type": "array", "description": "Optional exact HUD client group names/program labels to include.", "items": { "type": "string" } }, "hasActiveAssistance": { "title": "Has active assistance", "type": "boolean", "description": "Filter by HUD HAS_ACTIVE_ASSISTANCE_IND. Leave unset to include all." }, "isSubsidized": { "title": "Is subsidized", "type": "boolean", "description": "Filter by HUD IS_SUBSIDIZED_IND. Leave unset to include all." }, "isOnWatchList": { "title": "On HUD watch list", "type": "boolean", "description": "Filter by HUD IS_ON_WATCH_LIST_IND. Leave unset to include all." }, "isTroubled": { "title": "Troubled status", "type": "boolean", "description": "True returns properties with a non-empty troubled code; false returns properties without one." }, "minAssistedUnits": { "title": "Minimum assisted units", "minimum": 0, "type": "integer", "description": "Only include properties with at least this many assisted units." }, "minTotalUnits": { "title": "Minimum total units", "minimum": 0, "type": "integer", "description": "Only include properties with at least this many total units." }, "contractExpirationFrom": { "title": "Expiration from", "type": "string", "description": "Include properties whose first or second contract expiration date is on/after this date (YYYY-MM-DD)." }, "contractExpirationTo": { "title": "Expiration to", "type": "string", "description": "Include properties whose first or second contract expiration date is on/before this date (YYYY-MM-DD)." }, "maxItems": { "title": "Maximum properties", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Maximum HUD property records to save. Increase for bulk exports after testing filters.", "default": 100 }, "includeGeometry": { "title": "Include ArcGIS geometry", "type": "boolean", "description": "Adds raw ArcGIS geometry to each dataset item when available.", "default": false }, "includeRaw": { "title": "Include raw HUD attributes", "type": "boolean", "description": "Adds the full raw ArcGIS attributes object for audit/debug workflows. This makes output much wider.", "default": 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 } } }, "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 } } } } } } } } } }